PRprefecthq
Flow Run States

Read Flow Run State

Get a flow run state by id.

get/api/flow_run_states/{id}

Request

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

Path parameters

idstring uuid required

The flow run state id

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
dataunknown

Example response

{
  "message": "Run started"
}

Changes

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