Skip to main content
POST
Cancel a workflow run

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

app_id
string
required

ID of the app whose workflows you want to work with.

workflow_id
string
required

ID of the workflow, as returned in id by List workflows.

run_id
string
required

ID of the run, as returned in run_id by List runs for a workflow.

Response

The cancel was accepted, or the run had already finished.

status
string
required

This is cancelling when the request was accepted. On a run that had already finished, it's that run's existing status instead, and nothing changed.

Example:

"cancelling"

run_id
string
required

ID of the run.

Example:

"0195f2a1-4c3e-7b21-9f0d-2a5c8e1b4d77"