Sign in
Deployments

Get Scheduled Flow Runs For Deployments

Get scheduled runs for a set of deployments. Used by a runner to poll for work.

post/api/deployments/get_scheduled_flow_runs

Headers

x-prefect-api-versionstring

Request body

deployment_idsstring[] required

The deployment IDs to get scheduled runs for

scheduled_beforestring date-time

The maximum time to look for scheduled flow runs

limitinteger

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

Successful Response

idstring uuid
createdstring date-time
updatedstring date-time
namestring

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

flow_idstring uuid required

The id of the flow being run.

state_idstring uuid

The id of the flow run's current state.

deployment_idstring uuid

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

deployment_versionstring

The version of the deployment associated with this flow run.

work_queue_idstring uuid

The id of the run's work pool queue.

work_queue_namestring

The work queue that handled this flow run.

flow_versionstring

The version of the flow executed in this flow run.

parametersobject

Parameters for the flow run.

idempotency_keystring

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

contextobject

Additional context for the flow run.

tagsstring[]

A list of tags on the flow run

parent_task_run_idstring uuid

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

state_type'SCHEDULED' | 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'CRASHED' | 'PAUSED' | 'CANCELLING'

Enumeration of state types.

state_namestring

The name of the current flow run state.

run_countinteger

The number of times the flow run was executed.

expected_start_timestring date-time

The flow run's expected start time.

next_scheduled_start_timestring date-time

The next time the flow run is scheduled to start.

start_timestring date-time

The actual start time.

end_timestring date-time

The actual end time.

total_run_timenumber

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

estimated_run_timenumber

A real-time estimate of the total run time.

estimated_start_time_deltanumber

The difference between actual and expected start time.

auto_scheduledboolean

Whether or not the flow run was automatically scheduled.

infrastructure_document_idstring uuid

The block document defining infrastructure to use this flow run.

infrastructure_pidstring

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

work_pool_idstring uuid

The id of the flow run's work pool.

work_pool_namestring

The name of the flow run's work pool.

job_variablesobject

Variables used as overrides in the base job template

Example response

[
  {
    "name": "my-flow-run",
    "deployment_version": "1.0",
    "flow_version": "1.0",
    "context": {
      "my_var": "my_val"
    },
    "tags": [
      "tag-1",
      "tag-2"
    ],
    "work_pool_name": "my-work-pool",
    "state": {
      "message": "Run started"
    }
  }
]

Changes

Changed in 4 of the 50 revisions of this API.4

  • 29ba6c4f88371See the full diff
    • ○

      added the optional property items/empirical_policy/retry_type to the response with the 200 status

      response-optional-property-added

  • 0803f67b017b1See the full diff
    • ○

      added the optional property items/deployment_version to the response with the 200 status

      response-optional-property-added

  • f5252435d1571See the full diff
    • ○

      the response property items/flow_id became required for the status 200

      response-property-became-required

  • 5ea7df68007c1See the full diff
    • ○

      added the optional property items/job_variables to the response with the 200 status

      response-optional-property-added