Sign in
Flow Run States

Read Flow Run States

Get states associated with a flow run.

get/api/flow_run_states/

Query parameters

flow_run_idstring uuid required

Headers

x-prefect-api-versionstring

Response

Successful Response

idstring uuid
type'SCHEDULED' | 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'CRASHED' | 'PAUSED' | 'CANCELLING' required

Enumeration of state types.

namestring
timestampstring date-time
messagestring
{"stackTrail":"components:schemas:State:properties:data","oasType":"schema","type":"unknown","title":"Data","description":"Data associated with the state, e.g. a result. Content must be storable as JSON."}

Example response

[
  {
    "message": "Run started"
  }
]

Changes

No recorded changes to this endpoint across all 50 revisions of this API.