TLtlmtr
Catalog

Delete catalog snapshot.

Changed on

Free for Credits keys, including cascade deletion; no credits or request quota are consumed. An active key and snapshot access are still required.

Delete a snapshot owned by your user. Set cascade=true to also delete its stored diffs and their change lists. By default, existing diffs are retained and remain readable until they expire; new diffs require an active snapshot. The response indicates whether a snapshot was deleted and how many diffs were deleted. Concurrent mutations may return 429; retry after Retry-After. Catalog and snapshot access must both be enabled.

delete/v1/catalog/snapshots/{snapshot_id}

Request

Path parameters

snapshot_idstring required

Unique snapshot identifier. Pass the value returned when creating or listing snapshots unchanged.

Query parameters

cascadeboolean

Also delete the snapshot's diffs and their change lists. Default: false.

Response

snapshot_deletedboolean required

Whether this request deleted the snapshot.

diffs_deletedinteger required

Number of diffs deleted together with the snapshot. Zero when cascade is false.

Changes