Cancel Execution

Cancel a running or queued execution. Requires write-level access to the workflow. Scoped and organization keys need a write grant. success is true when the cancellation was durably recorded, aborted an in-process run, or cancelled the durable workflow.

POST/api/workflows/{id}/executions/{executionId}/cancel
X-API-Key<token>

Your SteelEngine API key (personal, workspace, or organization). Create personal and workspace keys under Settings > API Keys. Create organization keys under Organization Settings > API Keys.

In: header

Path Parameters

id*string

The unique identifier of the workflow.

executionId*string

The unique identifier of the execution to cancel.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/workflows/string/executions/string/cancel"
{  "success": true,  "executionId": "exec_abc123",  "redisAvailable": true,  "durablyRecorded": true,  "locallyAborted": false,  "temporalCancelled": true}