foliot docs

API reference / Workflows / Operational health of one workflow

Operational health of one workflow

GET/apps/{appId}/workflows/{workflow}/health

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

Counts by status, where runs are sitting, 24-hour outcomes, duration percentiles and scheduler lag. Returned unwrapped — the health object is the whole body. oldestDueAgeMs is the one to alert on: the age of the oldest run that is due but has not been picked up.

Path parameters

appId
string
REQUIRED

The app's name.

workflow
string
REQUIRED

The workflow's name.

Responses

200 WorkflowHealth OK
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.