CatalogRevisions


GET /{o}/{p}/catalog-revisions

List catalog revisions

List the append-only apply history for this project (most recent first).

Auth: Bearer token required · Permission: catalog:read

Path parameters

NameTypeDescription
ostring
pstring

Responses

StatusDescriptionSchema
200Catalog revisionsCatalogRevisionList

GET /{o}/{p}/catalog-revisions/{id}

Get a catalog revision by id

Auth: Bearer token required · Permission: catalog:read

Path parameters

NameTypeDescription
ostring
pstring
idstring

Responses

StatusDescriptionSchema
200The catalog revisionCatalogRevision
404Catalog revision not foundError

GET /{o}/{p}/catalog-revisions/{id}/snapshots

List per-item snapshots for a revision

Returns the pre/post images recorded for each item applied in this revision (the rollback substrate).

Auth: Bearer token required · Permission: catalog:read

Path parameters

NameTypeDescription
ostring
pstring
idstring

Responses

StatusDescriptionSchema
200Hunk snapshotsCatalogRevisionSnapshotList
404Catalog revision not foundError

POST /{o}/{p}/catalog-revisions/{id}/rollback

Roll back a catalog revision

Apply the inverse of a prior revision (or a single hunk via ?hunkId=). Runs the same destructive-check + apply pipeline as POST /apply; returns 207 when some inverse items fail. Requires apply:write.

Auth: Bearer token required · Permission: apply:write

Path parameters

NameTypeDescription
ostring
pstring
idstring

Request body (application/json)

FieldTypeDescription
forceboolean

Responses

StatusDescriptionSchema
200Rollback appliedCatalogRevisionRollbackResult
207Partial rollback — some items failedCatalogRevisionRollbackResult
404Catalog revision not foundError
409Destructive change rejected without forceError

Schemas

CatalogRevision

FieldTypeDescription
idstring(required)
projectIdstring,null(required)
appliedAtstring(required)
appliedBystring,null(required)
itemsobject[](required)
deletionsobject[](required)
responseobject
forceboolean(required)

CatalogRevisionList

Type: CatalogRevisionListItem[]

CatalogRevisionListItem

FieldTypeDescription
idstring(required)
projectIdstring,null(required)
appliedAtstring(required)
appliedBystring,null(required)
forceboolean(required)
itemCountinteger(required)
deletionCountinteger(required)
versioninteger(required)

CatalogRevisionRollbackResult

FieldTypeDescription
revisionIdstring(required)
rolledBackFromstring(required)
hunkIdstring,null(required)
succeededobject[](required)
failedobject[](required)
skippedobject[](required)

CatalogRevisionSnapshotList

Type: object[]

Error

FieldTypeDescription
errorstring(required)
codestring