Skip to main content
POST
Stop a plan in progress

Authorizations

Authorization
string
header
required

Headers

X-Workspace-Id
string<uuid>
required

UUID of the workspace to act in. Take it from GET /me (workspaces[].id). A key scoped to specific workspaces is rejected with 403 WORKSPACE_NOT_ALLOWED for any other id; a missing header is 400 WORKSPACE_REQUIRED.

Idempotency-Key
string<uuid>

A UUID that identifies this command. Retrying with the same key replays the original result instead of repeating the work. Without it, a retry is a new command.

Path Parameters

planId
string<uuid>
required

Body

application/json
expectedStatus
enum<string>
required
Available options:
planned,
authorized,
running,
all_ready,
publishing,
partial,
needs_review
reason
string
required
Required string length: 1 - 500
requestId
string<uuid>

Response

Plan cancelled (or the same cancellation replayed)

data
object
required