Skip to main content
Every page publish or theme publish creates a deployment record that tracks the build through to live. The Deployments resource lets you list those records, inspect a single deployment, cancel a build still in flight, or promote a tested deployment. By the end of this page you will know the statuses a deployment moves through and which transitions you can drive.

​
A deployment in shape

​
Endpoints

List all deployments for the workspace, newest first. Fetch a single deployment record. Cancel a deployment that is still in flight. Promote a deployment to live.

​
Status values

completed_at is set when a deployment reaches any terminal status and is null until then.

​
Allowed transitions

FromActionResult
pending, buildingPOST .../cancelMoves to cancelled. Irreversible.
building(server-driven)Moves to live on success or failed on error
Promotable statePOST .../promoteMoves to live
Any terminal statePOST .../cancel409 already_terminal
Cancellation is irreversible. To undo a publish, run a fresh publish or roll back the page through Pages — do not rely on cancel for that.

​
Common errors

Pages

Publishing a page or theme is what creates a deployment record.