Request a run's cancellation
Requests cancellation of a workflow run; effects already performed are not rolled back. Requires permission runs:manage.
v2 compatibility notes
A request, not a rollback
Cancellation was requested. The run reportscancellation_requested until in-flight work drains, then cancelled (or failed if the drain could not finish). A legacy run that no orchestrator drives has nothing to drain: it ends cancelled at once and the answer’s status says so. Effects already performed are not rolled back: a step that already sent a message, wrote a record or called another system stays done. Forge stops dispatching new nodes, stops a running agent before its next tool call, and stops the run’s sandboxes. A step already waiting for a person’s response is in-flight work: the run stays cancellation_requested until that step is answered or times out. A node parked behind a governance hold has not started, so it does not delay cancellation. Poll GET /api/v2/runs/get for the final status.
The body is exactly { "id": "<runId>", "reason": "<optional, at most 1,000 characters>" }; any other field is a 400. reason is recorded on the run.
accepted and the rest already_requested.
Who may cancel a run
The run is decided at the run’s home: its own org unit when it records one (a trigger launch), else its workflow’s owning org unit.- A run you cannot read — you need
runs:readat its home and at every company it carries — answers404like a missing run. - A run you can read but whose home you do not hold
runs:manageat answers403withrequiredPermission: "runs:manage".
409 idempotency_result_unavailable, and the run is never cancelled twice (see Idempotency).
Resume was retired
POST /api/v2/runs/resume was removed. It resumed delegated runs, whose dispatch was removed, so every call answered 500. A workflow run held for a person continues on its own after an eligible person approves; read GET /api/v2/runs/getTrustStatus for its continuation. Restarting a failed run and retrying a notification need runs:manage.Authorizations
Headers
1–255 printable ASCII characters (0x21–0x7E, no spaces), scoped to the calling credential. A repeat with the same key and request never runs the write again, a 5xx included: once the operation's permissions pass again it answers the identical status and body of the first response (Idempotent-Replayed: true, also sent as Idempotency-Replayed: true), unless the operation's own replay policy withholds it; a first response that was not stored (over 32 KiB, or carrying a one-time secret) answers its first status with only data.id (Idempotency-Replay-Disclosure: id-only) when it named one; otherwise 409 idempotency_result_unavailable; a repeat while the first is still running is 409 idempotency_key_in_flight, and the same key with a different request is 422 idempotency_key_reuse. Honoured for External App JWTs and platform and Personal keys; an External App's static companion key is not protected.
1 - 255Body
Response
Cancellation requested, or the run's unchanged status
accepted: this request moved the run to cancellation_requested; poll GET /api/v2/runs/get until it reports cancelled (or failed if the drain could not finish). A legacy run that no orchestrator drives has nothing to drain and is already cancelled. already_requested and already_terminal: nothing changed, and status is the run's current status. Effects already performed are not rolled back.

