Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2025-01-16170291390.7 KB
Work Pools

Read Work Queues

Read all work pool queues

post/api/work_pools/{work_pool_name}/queues/filter

Path parameters

work_pool_namestring required

The work pool name

The work pool name

Headers

x-prefect-api-versionstring

Request body

offsetinteger
limitinteger

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Example request

{
  "work_queues": {
    "name": {
      "any_": [
        "wq-1",
        "wq-2"
      ],
      "startswith_": [
        "marvin",
        "Marvin-robot"
      ]
    }
  }
}

Response

Successful Response

idstring uuid
createdstring date-time
updatedstring date-time
namestring required

The name of the work queue.

descriptionstring

An optional description for the work queue.

is_pausedboolean

Whether or not the work queue is paused.

concurrency_limitinteger

An optional concurrency limit for the work queue.

priorityinteger

The queue's priority. Lower values are higher priority (1 is the highest).

work_pool_idstring uuid

The work pool with which the queue is associated.

last_polledstring date-time

The last time an agent polled this queue for work.

work_pool_namestring

The name of the work pool the work pool resides within.

status'READY' | 'NOT_READY' | 'PAUSED'

Enumeration of work queue statuses.