Skip to main content

Cancel Workflow Execution

POST 

/api/automation/workflow-executions/:execution/cancel

Cancel a run that is pending or waiting (paused on an external callback or an agent runner). The run ends as canceled, its open waits close, and any queued or claimed agent job is withdrawn; callbacks that arrive later are rejected with 409.

Required scope: settings:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Allowed for users who manage workflows (workflows.index), and for users with workflows.run cancelling a run they started themselves. No request body.

Path parameters

  • execution - the run (execution) id.

Returns the canceled run under data, with its steps and waits (same fields as Get Workflow Execution). Returns 403 when the user may not cancel it, 404 when it does not exist, and 409 when the run is not pending or waiting (for example already completed, failed or running).

Request​

Responses​

OK

Response Headers
    Content-Type