PRprefecthq
Work Queues

Create Work Queue

Changed on

Creates a new work queue.

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

post/api/work_queues/

Request

  • The document declares no server URL.
  • Auth
    none declared

Headers

x-prefect-api-versionstring

Request body

namestring required

The name of the work queue.

descriptionstring

An optional description for the work queue.

is_pausedboolean

Whether or not the work queue is paused.

concurrency_limitinteger

The work queue's concurrency limit.

priorityinteger

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

Response

Successful Response

idstring uuid
createdstring date-time
updatedstring date-time
namestring required

The name of the work queue.

descriptionstring

An optional description for the work queue.

is_pausedboolean

Whether or not the work queue is paused.

concurrency_limitinteger

An optional concurrency limit for the work queue.

priorityinteger

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

work_pool_idstring uuid

The work pool with which the queue is associated.

last_polledstring date-time

The last time an agent polled this queue for work.

work_pool_namestring

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

status'READY' | 'NOT_READY' | 'PAUSED'

Enumeration of work queue statuses.

Changes