Work Pools
Create Work Pool
Work Pools
Create Work Pool
Creates a new work pool. If a work pool with the same name already exists, an error will be raised.
POST
/
api
/
work_pools
/
Headers
Body
application/json
Data used by the Prefect REST API to create a work pool.
The name of the work pool.
The work pool description.
The work pool type.
The work pool's base job template.
Pausing the work pool stops the delivery of all work.
A concurrency limit for the work pool.
Required range:
x > 0Response
201 - application/json
An ORM representation of a work pool
The name of the work pool.
The work pool type.
A description of the work pool.
The work pool's base job template.
Pausing the work pool stops the delivery of all work.
A concurrency limit for the work pool.
Required range:
x > 0The current status of the work pool.
Available options:
READY, NOT_READY, PAUSED The id of the pool's default queue.
Was this page helpful?