Update Work Queue

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

PATCH

api

work_queues

{id}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Headers

x-prefect-api-version

string

Path Parameters

string<uuid>

required

The work queue id

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.

Show child attributes

filter.tags

string[] | null

Only include flow runs with these tags in the work queue.

filter.deployment_ids

string<uuid>[] | null

Only include flow runs from these deployments in the work queue.

Response

Successful Response

Delete Work Queue Read Work Queue By Name

⌘I

API Reference

Headers

Path Parameters

Body

Response