Skip to main content
PATCH
/
api
/
work_pools
/
{work_pool_name}
/
queues
/
{name}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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