Skip to navigation

Flows · Runs · Pause a run after its in-flight tasks finish

View as Markdown

Suspends scheduling on a running execution. Status becomes PAUSED.

Not immediate. Tasks already in flight run to completion; only the scheduling of subsequent tasks stops. Reversible.

resource: workflow://run-control covers pause versus terminate.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

run_idstringRequired

UUID of a single workflow execution, from flows_startWorkflow (returned as workflow_id) or flows_listWorkflowRuns (returned as id). NOT the small integer workflow-definition ID.

Response

Run paused. Empty body.

Errors

400
Bad Request Error
404
Not Found Error