Set Flow Run State

Set a flow run state, invoking any orchestration rules.

post/api/flow_runs/{id}/set_state

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

Changed in 1 of the 50 revisions of this API.1415

Apr 3, 202493ae2b3f2efd1415See the full diff
- ▲
  added StateDetails to the state/allOf[subschema #1: StateCreate]/state_details request property allOf list
  request-property-all-of-added
- ▲
  added StateType to the state/allOf[subschema #1: StateCreate]/type request property allOf list
  request-property-all-of-added
- ▲
  the request property state/allOf[subschema #1: StateCreate]/type became required
  request-property-became-required
- ▲
  removed the enum value CANCELLED of the request property state/allOf[subschema #1: StateCreate]/type
  request-property-enum-value-removed
- ▲
  removed the enum value CANCELLING of the request property state/allOf[subschema #1: StateCreate]/type
  request-property-enum-value-removed
- ▲
  removed the enum value COMPLETED of the request property state/allOf[subschema #1: StateCreate]/type
  request-property-enum-value-removed
- ▲
  removed the enum value CRASHED of the request property state/allOf[subschema #1: StateCreate]/type
  request-property-enum-value-removed
- ▲
  removed the enum value FAILED of the request property state/allOf[subschema #1: StateCreate]/type
  request-property-enum-value-removed
- ▲
  removed the enum value PAUSED of the request property state/allOf[subschema #1: StateCreate]/type
  request-property-enum-value-removed
- ▲
  removed the enum value PENDING of the request property state/allOf[subschema #1: StateCreate]/type
  request-property-enum-value-removed
- ▲
  removed the enum value RUNNING of the request property state/allOf[subschema #1: StateCreate]/type
  request-property-enum-value-removed
- ▲
  removed the enum value SCHEDULED of the request property state/allOf[subschema #1: StateCreate]/type
  request-property-enum-value-removed
- ▲
  the state/allOf[subschema #1: StateCreate]/state_details request property type/format changed from object/ to /
  request-property-type-changed
- ▲
  the state/allOf[subschema #1: StateCreate]/type request property type/format changed from string/ to /
  request-property-type-changed
- ●
  removed the request property state/allOf[subschema #1: StateCreate]/state_details/cache_expiration
  request-property-removed
- ●
  removed the request property state/allOf[subschema #1: StateCreate]/state_details/cache_key
  request-property-removed
- ●
  removed the request property state/allOf[subschema #1: StateCreate]/state_details/child_flow_run_id
  request-property-removed
- ●
  removed the request property state/allOf[subschema #1: StateCreate]/state_details/flow_run_id
  request-property-removed
- ●
  removed the request property state/allOf[subschema #1: StateCreate]/state_details/pause_key
  request-property-removed
- ●
  removed the request property state/allOf[subschema #1: StateCreate]/state_details/pause_reschedule
  request-property-removed
- ●
  removed the request property state/allOf[subschema #1: StateCreate]/state_details/pause_timeout
  request-property-removed
- ●
  removed the request property state/allOf[subschema #1: StateCreate]/state_details/refresh_cache
  request-property-removed
- ●
  removed the request property state/allOf[subschema #1: StateCreate]/state_details/retriable
  request-property-removed
- ●
  removed the request property state/allOf[subschema #1: StateCreate]/state_details/run_input_keyset
  request-property-removed
- ●
  removed the request property state/allOf[subschema #1: StateCreate]/state_details/scheduled_time
  request-property-removed
- ●
  removed the request property state/allOf[subschema #1: StateCreate]/state_details/task_parameters_id
  request-property-removed
- ●
  removed the request property state/allOf[subschema #1: StateCreate]/state_details/task_run_id
  request-property-removed
- ●
  removed the request property state/allOf[subschema #1: StateCreate]/state_details/transition_id
  request-property-removed
- ●
  removed the request property state/allOf[subschema #1: StateCreate]/state_details/untrackable_result
  request-property-removed

Full history