foliot docs

API reference / Runs / Search runs

Search runs

GET/apps/{appId}/runs

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

Filters combine with AND. cursor is opaque — echo nextCursor back verbatim and do not parse it. nextCursor is null on the last page. Note that step and failedStep are different questions: after a compensation runs, a failed run’s current step is the compensation, while its error still names the step that failed.

Path parameters

appId
string
REQUIRED

The app's name.

Query parameters

workflow
string
OPTIONAL

Restrict to one workflow.

version
integer (int64)
OPTIONAL

Restrict to one registered version.

min -2147483648 · max 2147483647

status
string[]
OPTIONAL

Repeatable. One or more run statuses.

step
string
OPTIONAL

Runs currently sitting at this step.

failedStep
string
OPTIONAL

Runs whose recorded error happened at this step.

businessKey
string
OPTIONAL
tag
string
OPTIONAL
createdFrom
string (date-time)
OPTIONAL

Inclusive lower bound on creation.

createdTo
string (date-time)
OPTIONAL

Exclusive upper bound, so consecutive windows tile without double-counting.

stepCompleted
string
OPTIONAL

Runs that completed this step. Requires the workflow filter.

stepCompletedFrom
string (date-time)
OPTIONAL
stepCompletedTo
string (date-time)
OPTIONAL
cursor
string
OPTIONAL

Opaque; from a previous nextCursor.

limit
integer (int64)
OPTIONAL

min 1 · max 500 · default 50

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.