Cancel a workflow run
POST /v1/runs/{id}/cancel
POST
/v1/runs/{id}/cancel
Cancels the current stage and prevents future stages. This is the only cancellation path for workflow-stage batches.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string
Run ID
Responses
Section titled “ Responses ”Run canceled or already terminal.
object
run_id
string
state
string
jobs_canceled
integer
Missing or invalid API key.
object
error
required
string
Example
invalid request field
Field that failed validation.
string
detail
string
hint
string
Resource missing or not owned by this account.
object
error
required
string
Example
invalid request field
Field that failed validation.
string
detail
string
hint
string