foliot docs

API reference / Runs / Skip the current step

Skip the current step

POST/apps/{appId}/runs/{runId}/skip

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

Records a placeholder output naming the reason and moves on. The generation bumps, so an attempt still in flight cannot land after the run has passed the step.

Path parameters

appId
string
REQUIRED

The app's name.

runId
string (uuid)
REQUIRED

Request body

output
any
OPTIONAL

Overrides the placeholder, for a step whose output the next one needs.

reason
string
REQUIRED

min length 1 · max length 1000

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.
409 Error Conflicts with existing state.
503 Error A dependency this route needs is unreachable.