opschain runs pause
Included from Basic tier
opschain runs pause <run-id> [--reason <text>]
Pauses a server run — a change or a workflow run, addressed by id with the
same family disambiguation as runs cancel: the change verb is tried
first and a not-found falls through to the workflow-run verb (the API v2
ChangeService.PauseChange, then WorkflowRunService.PauseWorkflowRun).
A pause holds the run before its next step: steps already running finish
normally (their roll-up still applies), but no new step dispatches until the
run is resumed. While paused the run reports pause_state pausing (held,
with released steps still finishing) and then paused (fully held); gates
(runs approve|continue|reject) still answer, runs cancel still works, and
the hold survives a server restart. A workflow run's already-spawned nested
change keeps executing — the paused parent holds before its next workflow
step.
Pausing needs the execute right on the change's action path (or the workflow's path) — the same right that created the run.
Flags
| Flag | Meaning |
|---|---|
--reason <text> | Audit note recorded with the pause — shown in the run's paused_by history and the pause audit event. |
Output
paused run 0199c81e-… — pause state pausing
Named errors
Change is already paused/Workflow run is already paused— 422; the run is already held.Change cannot be paused because it is already finalised(or the workflow run form) — 422; a terminal run cannot be paused.run "<id>" not found— neither family knows the id (or it is not visible to the caller).
See also: runs resume, runs cancel, runs show.