Cancel a workflow run
Asks a running workflow to stop.
status comes back as cancelling, not cancelled: the request is acknowledged here and the run writes its final row once it stops. Poll Get workflow run to see it settle.
Calling this on a run that has already finished is not an error. You get a 200 carrying that run’s current status and nothing changes, so a cancel racing a run that just completed is safe to retry.
This endpoint is limited to 10 requests per minute.
Authorizations
Personal API key.
Path Parameters
ID of the app whose workflows you want to work with.
ID of the workflow, as returned in id by List workflows.
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.