v1

latestOpenAPI 3.1.0raw.githubusercontent.com2024-11-08170291390.5 KB

Flow Runs

Set Flow Run State

Set a flow run state, invoking any orchestration rules.

post/api/flow_runs/{id}/set_state

idstring uuid required

The flow run id

x-prefect-api-versionstring

forceboolean

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

Successful Response

status'ACCEPT' | 'REJECT' | 'ABORT' | 'WAIT' required

Enumerates return statuses for setting run states.

{
  "state": {
    "message": "Run started"
  }
}