API Reference

Aligns the asset catalog by triggering a batch catalog alignment process.

post
https://localhost:44395/api/admin/system/align-catalog

Behavior: Initiates a batch action to align the asset catalog based on the provided alignment model. If no model is provided, default alignment settings are used. The actual alignment processing occurs asynchronously.

Authorization: No [Authorize] attribute, but the user must be an admin (checked via IsAdminUser).

Side Effects: Queues a batch catalog alignment job that processes and reconciles catalog entries asynchronously.

Error Scenarios: Returns 400 if the user is not an admin. Throws a VibrantException for permission failures.

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

The AlignCatalogModel containing alignment configuration options. If null, default settings are used.

Represents configuration parameters for a catalog alignment operation that reconciles assets between S3 storage and the DynamoDB catalog.

int32 | null

Gets or sets the current processing stage of the alignment operation.

string | null

Gets or sets the S3 bucket name to align.

boolean

Gets or sets a value indicating whether the alignment should run in a single thread rather than in parallel.

boolean

Gets or sets a value indicating whether existing processing jobs should be overridden during alignment.

string | null

Gets or sets the S3 continuation token for paginated listing of objects.

int32 | null

Gets or sets the current file counter for tracking progress through the alignment.

boolean | null

Gets or sets a value indicating whether folder statuses should be corrected during alignment.

boolean | null

Gets or sets a value indicating whether folders should be realigned with the catalog.

boolean | null

Gets or sets a value indicating whether files should be realigned with the catalog.

boolean | null

Gets or sets a value indicating whether assets should be reprocessed during alignment.

boolean | null

Gets or sets a value indicating whether orphan DynamoDB assets should be previewed without removal.

boolean | null

Gets or sets a value indicating whether orphan DynamoDB assets should be removed.

boolean | null

Gets or sets a value indicating whether assets should be bulk deleted during alignment.

boolean | null

Gets or sets a value indicating whether missing files should be undeleted in the catalog.

boolean | null

Gets or sets a value indicating whether DynamoDB assets with no corresponding S3 objects should be deleted.

objectKeyPrefixes
array of strings | null

Gets or sets the list of S3 object key prefixes to filter the alignment scope.

objectKeyPrefixes
extensions
array of strings | null

Gets or sets the list of file extensions to filter during alignment.

extensions
assetTypes
array of objects | null

Gets or sets the list of asset types to include in the alignment.

assetTypes
assetStatuses
array of objects | null

Gets or sets the list of asset statuses to include in the alignment.

assetStatuses
mediaTypes
array of objects | null

Gets or sets the list of media types to include in the alignment.

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

Generated from available request content types

Allowed:
Responses

Updated about 20 hours ago

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

Updated about 20 hours ago