Skip to main content
POST
/
work_queues
/
filter
Read Work Queues
curl --request POST \
  --url https://api.example.com/work_queues/filter \
  --header 'Content-Type: application/json' \
  --data '
{
  "offset": 0,
  "work_queues": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "name": {
      "any_": [
        "wq-1",
        "wq-2"
      ],
      "startswith_": [
        "marvin",
        "Marvin-robot"
      ]
    }
  },
  "limit": 123
}
'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "description": "",
    "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>",
    "active_slots": 123
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.prefect.io/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-prefect-api-version
string

Body

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

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