Work Pools
Read Work Queues
Read all work pool queues
POST
/
api
/
work_pools
/
{work_pool_name}
/
queues
/
filter
Headers
x-prefect-api-version
string
Path Parameters
work_pool_name
string
requiredThe work pool name
Body
application/json
work_queues
object
Filter work queues. Only work queues matching all criteria will be returned
offset
integer
default: 0limit
integer
Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.
Response
200 - application/json
id
string
created
string | null
updated
string | null
name
string
requiredThe name of the work queue.
description
string | null
default: An optional description for the work queue.
is_paused
boolean
default: falseWhether or not the work queue is paused.
concurrency_limit
integer | null
An optional concurrency limit for the work queue.
priority
integer
default: 1The queue's priority. Lower values are higher priority (1 is the highest).
work_pool_id
string | null
The work pool with which the queue is associated.
filter
object | null
deprecatedDEPRECATED: Filter criteria for the work queue.
last_polled
string | 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
Was this page helpful?