PRprefecthq
Work Pools

Create Work Pool

Changed on

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

post/api/work_pools/

Request

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

Headers

x-prefect-api-versionstring

Request body

namestring required

The name of the work pool.

descriptionstring

The work pool description.

typestring

The work pool type.

base_job_templateobject

The work pool's base job template.

is_pausedboolean

Pausing the work pool stops the delivery of all work.

concurrency_limitinteger

A concurrency limit for the work pool.

Response

Successful Response

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

The name of the work pool.

descriptionstring

A description of the work pool.

typestring required

The work pool type.

base_job_templateobject

The work pool's base job template.

is_pausedboolean

Pausing the work pool stops the delivery of all work.

concurrency_limitinteger

A concurrency limit for the work pool.

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

Enumeration of work pool statuses.

default_queue_idstring uuid

The id of the pool's default queue.

Changes