Skip to main content
POST
Read Work Queues

Headers

x-prefect-api-version
string

Body

application/json
offset
integer
default:0
Required range: x >= 0
work_queues
WorkQueueFilter · object | null

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

limit
integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

Successful Response

id
string<uuid>
required
created
string<date-time> | null
required
updated
string<date-time> | null
required
name
string
required

The name of the work queue.

Pattern: ^[^/%&><]+$
description
string | null
default:""

An optional description for the work queue.

is_paused
boolean
default:false

Whether or not the work queue is paused.

concurrency_limit
integer | null

An optional concurrency limit for the work queue.

Required range: x >= 0
priority
integer
default:1

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

work_pool_id
string<uuid> | null

The work pool with which the queue is associated.

filter
QueueFilter · object | null
deprecated

DEPRECATED: Filter criteria for the work queue.

last_polled
string<date-time> | null

The last time an agent polled this queue for work.

work_pool_name
string | null

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

status
enum<string> | null

The queue status.

Available options:
READY,
NOT_READY,
PAUSED
active_slots
integer | null

The number of concurrency slots currently in use. None when concurrency_limit is not set.