Skip to main content
Pause an active workflow run, stopping execution of future steps. Resume it later with clay workflows runs resume.
clay workflows runs pause <workflowId> <runId>

Arguments

ArgumentDescription
workflowIdWorkflow id, e.g. wf_abc123. Required.
runIdRun id, e.g. wfr_xyz789. Required.

Output

{
  "runId": "wfr_xyz789",
  "status": "paused"
}
FieldTypeDescription
runIdstringThe paused run.
status"paused"Run has been paused; future steps will not execute.

Errors

CodeExitNotes
validation_error2Run is not in a pausable state (already finished or paused).
not_found6No run with that id under that workflow.
auth_forbidden3The API key lacks the terracotta:cli scope.

Examples

clay workflows runs pause wf_abc123 wfr_xyz789
clay workflows runs pause wf_abc123 wfr_xyz789 | jq -r '.status'