Skip to main content
POST
Cancel a workflow run

Authorizations

api_key
string
header
required

Personal API key.

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.

Acknowledgement of a manual cancel request.

status is the run's status as observed at the moment of acknowledgement: "cancelling" when we accepted the request and asked Temporal to cancel; the run row will flip to "cancelled" once the interpreter writes its terminal row. For already-terminal runs we return their current status as an idempotent no-op so the optimistic UI doesn't flap.

status
string
required

cancelling when the request was accepted. On a run that had already finished, its existing status instead, and nothing changed.

Example:

"cancelling"

run_id
string
required

ID of the run.

Example:

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