latestOpenAPI 3.1.02026-08-10295186.7 KB

ec696334ff35

Catalogs

Replace Cancel

Beta. Catalog replace is a Beta feature and can change. Send the Batch-Beta: catalog-replace header on each call. <br/><br/>Cancels an open replace session. Batch discards the pending revision and all of its items. The live catalog does not change. A session that is already complete or cancelled returns 409 CATALOG_REPLACE_UNKNOWN.

post/catalogs/replace/cancel

Headers

X-Batch-Projectstring required

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

Batch-Betastring required

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 endpoint is in Beta. It accepts only requests that carry the catalog-replace flag. Batch rejects a request without the flag with a 400.

Request body

replace_tokenstring required

Token that /catalogs/replace/start returns.

Response

Empty success response

EmptyResponse required