Create Work Queue

Creates a new work queue.

If a work queue with the same name already exists, an error will be raised.

Headers

x-prefect-api-version

string

Body

application/json

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

name

string

required

The name of the work queue.

concurrency_limit

integer | null

The work queue's concurrency limit.

Required range: x > 0

description

string | null

default:

An optional description for the work queue.

filter

object | null

deprecated

DEPRECATED: Filter criteria for the work queue.

Show child attributes

filter.deployment_ids

string[] | null

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

filter.tags

string[] | null

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

is_paused

boolean

default:

false

Whether or not the work queue is paused.

priority

integer | null

The queue's priority. Lower values are higher priority (1 is the highest).

Required range: x > 0

Response

201 - application/json

created

string | null

required

id

string

required

name

string

required

The name of the work queue.

updated

string | null

required

concurrency_limit

integer | null

An optional concurrency limit for the work queue.

Required range: x > 0

description

string | null

default:

An optional description for the work queue.

filter

object | null

deprecated

DEPRECATED: Filter criteria for the work queue.

Show child attributes

filter.deployment_ids

string[] | null

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

filter.tags

string[] | null

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

is_paused

boolean

default:

false

Whether or not the work queue is paused.

last_polled

string | null

The last time an agent polled this queue for work.

priority

integer

default:

1

The queue's priority. Lower values are higher priority (1 is the highest).

Required range: x > 0

status

enum<string> | null

The queue status.

Available options:

READY,

NOT_READY,

PAUSED

work_pool_id

string | null

The work pool with which the queue is associated.

work_pool_name

string | null

The name of the work pool the work pool resides within.