Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2024-11-08170291390.5 KB
Task Run States

Read Task Run State

Get a task run state by id.

get/api/task_run_states/{id}

Path parameters

idstring uuid required

The task run state id

The task 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
{"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"
}