Skip to main content
GET
/
flow_run_states
/
{id}
Read Flow Run State
curl --request GET \
  --url https://api.example.com/flow_run_states/{id}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "message": "Run started",
  "data": "<unknown>",
  "state_details": {
    "flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "task_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "child_flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scheduled_time": "2023-11-07T05:31:56Z",
    "cache_key": "<string>",
    "cache_expiration": "2023-11-07T05:31:56Z",
    "deferred": false,
    "untrackable_result": false,
    "pause_timeout": "2023-11-07T05:31:56Z",
    "pause_reschedule": false,
    "pause_key": "<string>",
    "run_input_keyset": {},
    "refresh_cache": true,
    "retriable": true,
    "transition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "task_parameters_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "traceparent": "<string>",
    "deployment_concurrency_lease_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.prefect.io/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-prefect-api-version
string

Path Parameters

​
id
string<uuid>
required

The flow run state id

Response

Successful Response

Represents the state of a run.

​
id
string<uuid>
required
​
type
enum<string>
required

Enumeration of state types.

Available options:
SCHEDULED,
PENDING,
RUNNING,
COMPLETED,
FAILED,
CANCELLED,
CRASHED,
PAUSED,
CANCELLING
​
name
string | null
​
timestamp
string<date-time>
​
message
string | null
Example:

"Run started"

​
data
any | null

Data associated with the state, e.g. a result. Content must be storable as JSON.

​
state_details
StateDetails · object