API Reference

Cancel non-terminal execution

Requires the workflows:<name> entitlement for the execution and mutates only cancelable, non-terminal work. Lambda updates record a cancellation request, while other workflows cancel their run and execution; add-subdomain cannot be canceled after Route 53 has accepted its change.

POST/v1/executions/{id}/cancel

Requires the workflows: entitlement for the execution and mutates only cancelable, non-terminal work. Lambda updates record a cancellation request, while other workflows cancel their run and execution; add-subdomain cannot be canceled after Route 53 has accepted its change.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Execution ID.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/executions/string/cancel"
{  "execution": {    "cancellationRequestedAt": "string",    "createdAt": "string",    "currentStage": "string",    "executionId": "string",    "finishedAt": "string",    "principalId": "string",    "status": "canceled",    "workflow": "string"  },  "status": "cancellation_requested"}

Get execution GET

Reads one execution, its ordered stages, and any normalized onboarding outcome. The bearer principal must hold the workflows:<name> entitlement corresponding to that execution; the operation is valid in every execution state and does not mutate it.

Queue execution rollback POST

Requires the workflows:<name> entitlement for the execution. The mutating action queues receipt-backed rollback for a source workflow run, while a failed or canceled execution without a source run is marked rolled back immediately; Lambda restoration additionally requires a terminal execution with durable receipts.