POST
/
api
/
work_pools
/

Headers

x-prefect-api-version
string

Body

application/json

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

name
string
required

The name of the work pool.

description
string | null

The work pool description.

type
string
default: prefect-agent

The work pool type.

base_job_template
object

The work pool's base job template.

is_paused
boolean
default: false

Pausing the work pool stops the delivery of all work.

concurrency_limit
integer | null

A concurrency limit for the work pool.

Response

201 - application/json

An ORM representation of a work pool

id
string
created
string | null
updated
string | null
name
string
required

The name of the work pool.

description
string | null

A description of the work pool.

type
string
required

The work pool type.

base_job_template
object

The work pool's base job template.

is_paused
boolean
default: false

Pausing the work pool stops the delivery of all work.

concurrency_limit
integer | null

A concurrency limit for the work pool.

status
enum<string> | null

The current status of the work pool.

Available options:
READY,
NOT_READY,
PAUSED
default_queue_id
string | null

The id of the pool's default queue.