Create Work Pool

Creates a new work pool. If a work pool 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 pool.

name

string

required

The name of the work pool.

base_job_template

object

The work pool's base job template.

concurrency_limit

integer | null

A concurrency limit for the work pool.

Required range: x > 0

description

string | null

The work pool description.

is_paused

boolean

default:

false

Pausing the work pool stops the delivery of all work.

type

string

default:

prefect-agent

The work pool type.

Response

201 - application/json

An ORM representation of a work pool

created

string | null

required

id

string

required

name

string

required

The name of the work pool.

type

string

required

The work pool type.

updated

string | null

required

base_job_template

object

The work pool's base job template.

concurrency_limit

integer | null

A concurrency limit for the work pool.

Required range: x > 0

default_queue_id

string | null

The id of the pool's default queue.

description

string | null

A description of the work pool.

is_paused

boolean

default:

false

Pausing the work pool stops the delivery of all work.

status

enum<string> | null

The current status of the work pool.

Available options:

READY,

NOT_READY,

PAUSED