GET
/
api
/
work_pools
/
{work_pool_name}
/
queues
/
{name}

Headers

x-prefect-api-version
string

Path Parameters

work_pool_name
string
required

The work pool name

name
string
required

The work pool queue name

Response

200 - application/json
id
string
required
created
string | null
required
updated
string | null
required
name
string
required

The name of the work queue.

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).

Required range: x > 0
work_pool_id
string | null

The work pool with which the queue is associated.

filter
object | null
deprecated

DEPRECATED: 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