PRprefecthq
Task Run States

Read Task Run States

Get states associated with a task run.

get/api/task_run_states/

Request

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

Query parameters

task_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
dataunknown

Example response

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

Changes

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