Pause or resume a step

PUT/apps/{appId}/workflows/{workflow}/steps/{step}/control

Authenticate with an operator token or an app API key or a signed-in Foliot Console session.

Pausing parks runs already scheduled at this step — retry backoffs included — WITHOUT consuming an attempt, so a failing dependency stops costing retries immediately. Resuming releases the backlog at resumeRatePerSecond, because releasing it all at once would reproduce the load that caused the pause. Applies across every version of the workflow.

Path parameters

appId

string

REQUIRED

The app's name.

workflow

string

REQUIRED

step

string

REQUIRED

Request body

paused

boolean

REQUIRED

reason

string

OPTIONAL

max length 1000

resumeRatePerSecond

number (double)

OPTIONAL

min 0.1 · max 10000

Responses

200 object OK

400 Error Invalid request.

401 Error Missing, malformed or unknown bearer token.

403 Error The token is valid but not permitted on this route.

404 Error No such resource.

503 Error A dependency this route needs is unreachable.