Skip to main content
PATCH
/
work_pools
/
{work_pool_name}
/
queues
/
{name}
Update Work Queue
curl --request PATCH \
  --url https://api.example.com/work_pools/{work_pool_name}/queues/{name} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "is_paused": false,
  "concurrency_limit": 1,
  "priority": 1,
  "last_polled": "2023-11-07T05:31:56Z",
  "filter": {
    "tags": [
      "<string>"
    ],
    "deployment_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  }
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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

Path Parameters

​
work_pool_name
string
required

The work pool name

​
name
string
required

The work pool queue name

Body

application/json

Data used by the Prefect REST API to update a work queue.

​
name
string | null
​
description
string | null
​
is_paused
boolean
default:false

Whether or not the work queue is paused.

​
concurrency_limit
integer | null
Required range: x >= 0
​
priority
integer | null
Required range: x > 0
​
last_polled
string<date-time> | null
​
filter
QueueFilter · object
deprecated

DEPRECATED: Filter criteria for the work queue.

Response

Successful Response