GET
/
api
/
work_queues
/
name
/
{name}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "is_paused": false,
  "concurrency_limit": 1,
  "priority": 1,
  "work_pool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "filter": {
    "tags": [
      "<string>"
    ],
    "deployment_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  },
  "last_polled": "2023-11-07T05:31:56Z",
  "work_pool_name": "<string>",
  "status": "READY"
}

Headers

x-prefect-api-version
string

Path Parameters

name
string
required

The work queue name

Response

200
application/json
Successful Response
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