Skip to main content
POST
Bulk Set Flow Run State

Headers

x-prefect-api-version
string

Body

application/json
state
StateCreate · object
required

The state to set

flow_runs
FlowRunFilter · object | null

Filter criteria for flow runs to update

force
boolean
default:false

If false, orchestration rules will be applied that may alter or prevent the state transition. If True, orchestration rules are not applied.

limit
integer
default:50

Maximum number of flow runs to update. Defaults to 50.

Required range: 1 <= x <= 50

Response

Successful Response

Response from bulk set state operation.

results
FlowRunOrchestrationResult · object[]