latestOpenAPI 3.1.02026-08-10295186.7 KB

ec696334ff35

Catalogs

View

Get information about an existing catalog.

get/catalogs/view

Query parameters

namestring required

Catalog identifier to retrieve.

indexing_tokenstring

Optional token used for indexing state tracking.

Headers

X-Batch-Projectstring required

The unique project key, identifying a project on the Batch platform

Batch-Betastring

Value of the Batch-Beta header. It is a comma-separated list of Beta contract flags. Thus one request can opt into more than one Beta contract at the same time (first-flag, second-flag). Flags are lowercase and case-sensitive, and the order does not matter. Batch rejects an unknown flag with a 400 on any endpoint. When a contract becomes generally available, Batch continues to accept its flag but the flag has no more effect. Thus you never need to remove it.

Beta opt-in. This header is optional here, because the endpoint is stable. If you send the catalog-replace flag, the response also includes the Beta-only pending_replace block. If you do not send the flag, the response does not change.

Response

Successfully retrieved the catalog metadata.

namestring required

Unique identifier for the catalog, used for referencing in API calls.

itemsinteger required

Total number of items currently stored in this catalog.

sizeinteger required

Size of the catalog data in bytes.

createdstring date-time required

RFC 3339 UTC date indicating when the catalog was created.

updatedstring date-time required

RFC 3339 UTC date of the last update to the catalog.

indexing_state'IN_PROGRESS' | 'APPLIED'

Indicates the current indexing state of the catalog items.