PRprefecthq
Flow Runs

Set Flow Run State

Set a flow run state, invoking any orchestration rules.

post/api/flow_runs/{id}/set_state

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

idstring uuid required

The flow run id

Headers

x-prefect-api-versionstring

Request body

forceboolean

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

Response

Successful Response

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

Enumerates return statuses for setting run states.

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.