Redrive, rewind or cancel many runs

POST/apps/{appId}/bulk

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

Applies one action to every run matching filter. Send dryRun: true first — it answers 200 with just a count, so the blast radius is visible before committing. Submitting for real answers 202 with a job row to poll. The two branches return different statuses and different bodies.

Path parameters

appId

string

REQUIRED

The app's name.

Request body

action

"redrive" | "rewind" | "cancel"

REQUIRED

What to do to every matching run.

dryRun

boolean

OPTIONAL

Answer with just a count, and start nothing.

default false

filter

object

REQUIRED

fromStep

string

OPTIONAL

redrive only: restart from this step rather than where the run failed.

reason

string

OPTIONAL

Recorded on every run this touches.

max length 1000

toStep

string

OPTIONAL

rewind only, and required: the step to rewind to.

version

integer (int64)

OPTIONAL

rewind only: the workflow version to rewind onto.

min 1 · max 2147483647

Responses

200 object A dry run: the count the filter matches, and nothing started.

202 object Accepted

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.