Work Pools
Read Work Pools
Read multiple work pools
POST
/
api
/
work_pools
/
filter
Headers
Body
application/json
Filter work pools. Only work pools matching all criteria will be returned
Required range:
x > 0
Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.
Response
200 - application/json
The name of the work pool.
A description of the work pool.
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 > 0
The current status of the work pool.
Available options:
READY
, NOT_READY
, PAUSED
The id of the pool's default queue.
Was this page helpful?