Task Run States
Read Task Run State
Get a task run state by id.
GET
/
api
/
task_run_states
/
{id}
Headers
x-prefect-api-version
string
Path Parameters
id
string
requiredThe task run state id
Response
200 - application/json
Represents the state of a run.
id
string
type
enum<string>
requiredEnumeration of state types.
Available options:
SCHEDULED
, PENDING
, RUNNING
, COMPLETED
, FAILED
, CANCELLED
, CRASHED
, PAUSED
, CANCELLING
name
string | null
timestamp
string
message
string | null
data
any | null
Data associated with the state, e.g. a result. Content must be storable as JSON.
state_details
object
Was this page helpful?