v1

latestOpenAPI 3.1.0raw.githubusercontent.com2024-11-08170291390.5 KB

Work Pools

Get Scheduled Flow Runs

Load scheduled runs for a worker

post/api/work_pools/{name}/get_scheduled_flow_runs

Path parameters

namestring required

The work pool name

Headers

x-prefect-api-versionstring

Request body

work_queue_namesstring[]

The names of work pool queues

scheduled_beforestring date-time

The maximum time to look for scheduled flow runs

scheduled_afterstring date-time

The minimum time to look for scheduled flow runs

limitinteger

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

Successful Response

work_pool_idstring uuid required

work_queue_idstring uuid required

Example response

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