foliot docs

API reference / Runs / Cancel a run

Cancel a run

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

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

Terminal. A cancelled run cannot be redriven — use rewind to re-run it from a step.

Path parameters

appId
string
REQUIRED

The app's name.

runId
string (uuid)
REQUIRED

Request body

reason
string
OPTIONAL

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.