13. Run control
Operations
| Operation | Endpoint | Effect |
|---|---|---|
| Pause | PUT /api/workflow/{id}/pause | The run stops taking steps. Status PAUSED. Waiting tasks stay waiting. |
| Resume | PUT /api/workflow/{id}/resume | The run continues. Status RUNNING. |
| Terminate | DELETE /api/workflow/{id}?reason= | The run ends. Open worker messages are removed and their tasks set CANCELED; agent calls in progress are cancelled. The failure workflow starts if defined. Status TERMINATED. |
| Retry | POST /api/workflow/{id}/retry | A new run that reuses the recorded outputs of completed tasks and continues from the failed task. Linked by retry_of. |
| Restart | POST /api/workflow/{id}/restart?useLatestDefinitions=false | A new run from the first task with the same input. With true, the latest definition version is used. Linked by restart_of. |
| Rerun from a task | POST /api/workflow/{id}/rerun with {reRunFromTaskRefName, taskInput, workflowInput} | Like retry, resuming from a named task with optional new input. Linked by rerun_of. |
| Skip a task | PUT /api/workflow/{id}/skiptask/{ref} with {taskInput, taskOutput} | The waiting task is recorded SKIPPED with the given output and the run continues. |
| Reset callbacks | POST /api/workflow/{id}/resetcallbacks | Delayed worker messages for this run are re-sent immediately. |
| Bulk | /api/workflow/bulk/{operation} with a list of ids | The same operation on each id, with a result per id. |
A definition with restartable: false rejects restart and rerun.
Test runs
POST /api/workflow/test with {workflowDef, input, taskRefToMockOutput} runs the interpreter with the given outputs substituted for activity and worker tasks. No external call is made. The pipeline uses this to test definitions.