ghostAPIv1 beta
Definitions

Archive a definition

POST/definitions/{definitionId}/archive
ScopeadminRoleOwner or adminBilling1 credit per call

Archives a definition. Existing assignments and history are retained; new assignments are rejected.

Path parameters

definitionIduuidrequired
Definition id.

Headers

Idempotency-Keystringoptional
1–128 visible ASCII characters. Retrying with the same key returns the original response; reusing it for different input returns 409.

Body

reasonstringrequired
Why this change is being made. 1–500 characters. Stored in the audit trail.

Response

Definition with archived_at set