GET
/
api
/
flow_runs
/
{id}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "name": "my-flow-run",
  "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "state_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deployment_version": "1.0",
  "work_queue_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "work_queue_name": "<string>",
  "flow_version": "1.0",
  "parameters": {},
  "idempotency_key": "<string>",
  "context": {
    "my_var": "my_val"
  },
  "empirical_policy": {
    "max_retries": 0,
    "retry_delay_seconds": 0,
    "retries": 123,
    "retry_delay": 123,
    "pause_keys": [
      "<string>"
    ],
    "resuming": true,
    "retry_type": "in_process"
  },
  "tags": [
    "tag-1",
    "tag-2"
  ],
  "labels": {
    "key": "value1",
    "key2": 42
  },
  "parent_task_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "state_type": "SCHEDULED",
  "state_name": "<string>",
  "run_count": 0,
  "expected_start_time": "2023-11-07T05:31:56Z",
  "next_scheduled_start_time": "2023-11-07T05:31:56Z",
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "total_run_time": 0,
  "estimated_run_time": 0,
  "estimated_start_time_delta": 0,
  "auto_scheduled": false,
  "infrastructure_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "infrastructure_pid": "<string>",
  "created_by": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "display_value": "<string>"
  },
  "work_pool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "work_pool_name": "my-work-pool",
  "state": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "SCHEDULED",
    "name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "message": "Run started",
    "data": "<any>",
    "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": true,
      "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>"
    }
  },
  "job_variables": {}
}

Headers

​
x-prefect-api-version
string

Path Parameters

​
id
string
required

The flow run id

Response

200
application/json
Successful Response
​
id
string
required
​
created
string | null
required
​
updated
string | null
required
​
flow_id
string
required

The id of the flow being run.

​
name
string

The name of the flow run. Defaults to a random slug if not specified.

​
state_id
string | null

The id of the flow run's current state.

​
deployment_id
string | null

The id of the deployment associated with this flow run, if available.

​
deployment_version
string | null

The version of the deployment associated with this flow run.

​
work_queue_id
string | null

The id of the run's work pool queue.

​
work_queue_name
string | null

The work queue that handled this flow run.

​
flow_version
string | null

The version of the flow executed in this flow run.

​
parameters
object

Parameters for the flow run.

​
idempotency_key
string | null

An optional idempotency key for the flow run. Used to ensure the same flow run is not created multiple times.

​
context
object

Additional context for the flow run.

​
empirical_policy
object

Defines of how a flow run should retry.

​
tags
string[]

A list of tags on the flow run

​
labels
object

A dictionary of key-value labels. Values can be strings, numbers, or booleans.

​
parent_task_run_id
string | null

If the flow run is a subflow, the id of the 'dummy' task in the parent flow used to track subflow state.

​
state_type
enum<string> | null

The type of the current flow run state.

Available options:
SCHEDULED,
PENDING,
RUNNING,
COMPLETED,
FAILED,
CANCELLED,
CRASHED,
PAUSED,
CANCELLING
​
state_name
string | null

The name of the current flow run state.

​
run_count
integer
default:
0

The number of times the flow run was executed.

​
expected_start_time
string | null

The flow run's expected start time.

​
next_scheduled_start_time
string | null

The next time the flow run is scheduled to start.

​
start_time
string | null

The actual start time.

​
end_time
string | null

The actual end time.

​
total_run_time
number
default:
0

Total run time. If the flow run was executed multiple times, the time of each run will be summed.

​
estimated_run_time
number
default:
0

A real-time estimate of the total run time.

​
estimated_start_time_delta
number
default:
0

The difference between actual and expected start time.

​
auto_scheduled
boolean
default:
false

Whether or not the flow run was automatically scheduled.

​
infrastructure_document_id
string | null

The block document defining infrastructure to use this flow run.

​
infrastructure_pid
string | null

The id of the flow run as returned by an infrastructure block.

​
created_by
object | null

Optional information about the creator of this flow run.

​
work_pool_id
string | null

The id of the flow run's work pool.

​
work_pool_name
string | null

The name of the flow run's work pool.

​
state
object | null

The current state of the flow run.

​
job_variables
object | null

Variables used as overrides in the base job template

Was this page helpful?

Create Flow RunDelete Flow Run