Read Work Queues

Query for work queues.

Headers

x-prefect-api-version

string

Body

application/json

limit

integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

offset

integer

default:

0

Required range: x > 0

work_queues

object

Filter work queues. Only work queues matching all criteria will be returned

Show child attributes

work_queues.id

object | null

Filter criteria for WorkQueue.id

Show child attributes

work_queues.id.any_

string[] | null

A list of work queue ids to include

work_queues.name

object | null

Filter criteria for WorkQueue.name

Show child attributes

work_queues.name.any_

string[] | null

A list of work queue names to include

work_queues.name.startswith_

string[] | null

A list of case-insensitive starts-with matches. For example, passing 'marvin' will match 'marvin', and 'Marvin-robot', but not 'sad-marvin'.

work_queues.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

Response

200 - application/json

created

string | null

required

id

string

required

name

string

required

The name of the work queue.

updated

string | null

required

concurrency_limit

integer | null

An optional concurrency limit for the work queue.

Required range: x > 0

description

string | null

default:

An optional description for the work queue.

filter

object | null

deprecated

DEPRECATED: Filter criteria for the work queue.

Show child attributes

filter.deployment_ids

string[] | null

Only include flow runs from these deployments in the work queue.

filter.tags

string[] | null

Only include flow runs with these tags in the work queue.

is_paused

boolean

default:

false

Whether or not the work queue is paused.

last_polled

string | null

The last time an agent polled this queue for work.

priority

integer

default:

1

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

Required range: x > 0

status

enum<string> | null

The queue status.

Available options:

READY,

NOT_READY,

PAUSED

work_pool_id

string | null

The work pool with which the queue is associated.

work_pool_name

string | null

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