Get Scheduled Flow Runs

[
  {
    "work_pool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "work_queue_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "flow_run": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "state_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deployment_version": "1.0",
      "work_queue_name": "<string>",
      "flow_version": "1.0",
      "parameters": {},
      "idempotency_key": "<string>",
      "context": {},
      "empirical_policy": {
        "max_retries": 0,
        "retry_delay_seconds": 0,
        "retries": 123,
        "retry_delay": 123,
        "pause_keys": [
          "<string>"
        ],
        "resuming": false,
        "retry_type": "in_process"
      },
      "tags": [
        "<string>"
      ],
      "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_queue_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "state": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "SCHEDULED",
        "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"
        }
      },
      "job_variables": {}
    }
  }
]

POST

api

work_pools

{name}

get_scheduled_flow_runs

[
  {
    "work_pool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "work_queue_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "flow_run": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "state_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deployment_version": "1.0",
      "work_queue_name": "<string>",
      "flow_version": "1.0",
      "parameters": {},
      "idempotency_key": "<string>",
      "context": {},
      "empirical_policy": {
        "max_retries": 0,
        "retry_delay_seconds": 0,
        "retries": 123,
        "retry_delay": 123,
        "pause_keys": [
          "<string>"
        ],
        "resuming": false,
        "retry_type": "in_process"
      },
      "tags": [
        "<string>"
      ],
      "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_queue_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "state": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "SCHEDULED",
        "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"
        }
      },
      "job_variables": {}
    }
  }
]

Headers

x-prefect-api-version

string

Path Parameters

name

string

required

The work pool name

Body

application/json

work_queue_names

string[]

The names of work pool queues

scheduled_before

string<date-time>

The maximum time to look for scheduled flow runs

scheduled_after

string<date-time>

The minimum time to look for scheduled flow runs

limit

integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

Successful Response

work_pool_id

string<uuid>

required

work_queue_id

string<uuid>

required

flow_run

FlowRun · object

required

An ORM representation of flow run data.

Show child attributes

flow_run.id

string<uuid>

required

flow_run.created

string<date-time> | null

required

flow_run.updated

string<date-time> | null

required

flow_run.flow_id

string<uuid>

required

The id of the flow being run.

flow_run.name

string

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

flow_run.state_id

string<uuid> | null

The id of the flow run's current state.

flow_run.deployment_id

string<uuid> | null

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

flow_run.deployment_version

string | null

The version of the deployment associated with this flow run.

Example:

"1.0"

flow_run.work_queue_name

string | null

The work queue that handled this flow run.

flow_run.flow_version

string | null

The version of the flow executed in this flow run.

Example:

"1.0"

flow_run.parameters

Parameters · object

Parameters for the flow run.

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.

flow_run.context

Context · object

Additional context for the flow run.

flow_run.empirical_policy

FlowRunPolicy · object

Defines of how a flow run should retry.

Show child attributes

flow_run.empirical_policy.max_retries

integer

default:0

deprecated

The maximum number of retries. Field is not used. Please use retries instead.

flow_run.empirical_policy.retry_delay_seconds

number

default:0

deprecated

The delay between retries. Field is not used. Please use retry_delay instead.

flow_run.empirical_policy.retries

integer | null

The number of retries.

flow_run.empirical_policy.retry_delay

integer | null

The delay time between retries, in seconds.

flow_run.empirical_policy.pause_keys

string[] | null

Tracks pauses this run has observed.

flow_run.empirical_policy.resuming

boolean | null

default:false

Indicates if this run is resuming from a pause.

flow_run.empirical_policy.retry_type

enum<string> | null

The type of retry this run is undergoing.

Available options:

in_process,

reschedule

flow_run.tags

string[]

A list of tags on the flow run

flow_run.labels

Labels · object

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

Show child attributes

flow_run.labels.{key}

Example:

{ "key": "value1", "key2": 42 }

flow_run.parent_task_run_id

string<uuid> | null

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

flow_run.state_type

enum<string> | null

The type of the current flow run state.

Available options:

SCHEDULED,

PENDING,

RUNNING,

COMPLETED,

FAILED,

CANCELLED,

CRASHED,

PAUSED,

CANCELLING

flow_run.state_name

string | null

The name of the current flow run state.

flow_run.run_count

integer

default:0

The number of times the flow run was executed.

flow_run.expected_start_time

string<date-time> | null

The flow run's expected start time.

flow_run.next_scheduled_start_time

string<date-time> | null

The next time the flow run is scheduled to start.

flow_run.start_time

string<date-time> | null

The actual start time.

flow_run.end_time

string<date-time> | null

The actual end time.

flow_run.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.

flow_run.estimated_run_time

number

default:0

A real-time estimate of the total run time.

flow_run.estimated_start_time_delta

number

default:0

The difference between actual and expected start time.

flow_run.auto_scheduled

boolean

default:false

Whether or not the flow run was automatically scheduled.

flow_run.infrastructure_document_id

string<uuid> | null

The block document defining infrastructure to use this flow run.

flow_run.infrastructure_pid

string | null

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

flow_run.created_by

CreatedBy · object

Optional information about the creator of this flow run.

Show child attributes

flow_run.created_by.id

string<uuid> | null

The id of the creator of the object.

flow_run.created_by.type

string | null

The type of the creator of the object.

flow_run.created_by.display_value

string | null

The display value for the creator.

flow_run.work_queue_id

string<uuid> | null

The id of the run's work pool queue.

flow_run.state

State · object

The current state of the flow run.

Show child attributes

flow_run.state.id

string<uuid>

required

flow_run.state.type

enum<string>

required

Enumeration of state types.

Available options:

SCHEDULED,

PENDING,

RUNNING,

COMPLETED,

FAILED,

CANCELLED,

CRASHED,

PAUSED,

CANCELLING

flow_run.state.name

string | null

flow_run.state.timestamp

string<date-time>

flow_run.state.message

string | null

Example:

"Run started"

flow_run.state.data

any | null

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

flow_run.state.state_details

StateDetails · object

Show child attributes

flow_run.state.state_details.flow_run_id

string<uuid> | null

flow_run.state.state_details.task_run_id

string<uuid> | null

flow_run.state.state_details.child_flow_run_id

string<uuid> | null

flow_run.state.state_details.scheduled_time

string<date-time> | null

flow_run.state.state_details.cache_key

string | null

flow_run.state.state_details.cache_expiration

string<date-time> | null

flow_run.state.state_details.deferred

boolean | null

default:false

flow_run.state.state_details.untrackable_result

boolean

default:false

flow_run.state.state_details.pause_timeout

string<date-time> | null

flow_run.state.state_details.pause_reschedule

boolean

default:false

flow_run.state.state_details.pause_key

string | null

flow_run.state.state_details.run_input_keyset

Run Input Keyset · object

Show child attributes

flow_run.state.state_details.run_input_keyset.{key}

string

flow_run.state.state_details.refresh_cache

boolean | null

flow_run.state.state_details.retriable

boolean | null

flow_run.state.state_details.transition_id

string<uuid> | null

flow_run.state.state_details.task_parameters_id

string<uuid> | null

flow_run.state.state_details.traceparent

string | null

flow_run.state.state_details.deployment_concurrency_lease_id

string<uuid> | null

flow_run.job_variables

Job Variables · object

Variables used as overrides in the base job template

Count Work Pools Create Work Queue

⌘I

API Reference

Headers

Path Parameters

Body

Response