Registers an existing storage object as a managed asset.

Behavior: Looks up an object in storage by its bucket name and object key, then creates a managed asset record for it. The asset will be indexed and made available for browsing, searching, and media operations. Both the bucket name and object key are required.

Authorization: Requires a valid Bearer token.

Side Effects: Creates a new asset record and triggers indexing.

Error Scenarios: Returns 400 if bucket name or object key is missing. Returns 401 if the caller is not authenticated. Returns 404 if no object exists at the specified bucket/key location.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The registration details including bucket name and object key.

Represents a request to register a new asset or update an existing asset in the system.

uuid | null

Gets or sets the unique identifier for the asset; if null, a new identifier will be generated.

uuid | null

Gets or sets the identifier of the parent folder where the asset should be placed.

string | null

Gets or sets the display-friendly version of the storage object key.

string
required
length ≥ 1

Gets or sets the name of the storage bucket where the asset is stored.

string
required
length ≥ 1

Gets or sets the object key that uniquely identifies the asset within the storage bucket.

string | null

Gets or sets the entity tag used to verify asset integrity.

tags
array of strings | null

Gets or sets the list of tag names to associate with the asset.

tags
collections
array of strings | null

Gets or sets the list of collection names to associate with the asset.

collections
relatedContent
array of uuids | null

Gets or sets the list of related content identifiers to link to the asset.

relatedContent
string | null

Gets or sets the sequencer value used for ordering storage events.

string | null
enum

Indicates the current processing or lifecycle status of an asset. An asset transitions through various statuses during operations such as upload, archive, restore, and delete.

Available

Renaming

Copying

Restoring

Registering

Uploading

Archiving

Archived

PendingArchive

PendingRestore

Restored

Deleting

Moving

SlugReplaced

Updating

Error

Assembling

Clipping

Placeholder

Creating

Replacing

string | null
enum

Standard

ReducedRedundancy

Glacier

StandardInfrequentAccess

OneZoneInfrequentAccess

IntelligentTiering

DeepArchive

GlacierInstantRetrieval

Outposts

string | null
enum

Categorizes the type of an asset in the media library.

Folder

File

Bucket

Allowed:
int64 | null

Gets or sets the file size of the asset in bytes.

string | null

Gets or sets the name of the storage event that triggered the registration.

date-time | null

Gets or sets the date when the asset was originally created.

string | null

Gets or sets the IP address of the source that initiated the storage event.

string | null

Gets or sets the external URL or path where the asset is located outside the system.

boolean

Gets or sets a value indicating whether the media processor should be started after registration.

boolean

Gets or sets a value indicating whether to delete the asset record if the underlying file is missing.

Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json