POST
/
api
/
work_pools
/
filter
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "description": "<string>",
    "type": "<string>",
    "base_job_template": {},
    "is_paused": false,
    "concurrency_limit": 1,
    "status": "READY",
    "default_queue_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

Headers

x-prefect-api-version
string

Body

application/json
work_pools
object | null

Filter work pools. Only work pools matching all criteria will be returned

offset
integer
default:
0
Required range: x > 0
limit
integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

200
application/json
Successful Response
id
string
required
created
string | null
required
updated
string | null
required
name
string
required

The name of the work pool.

type
string
required

The work pool type.

description
string | null

A description of the work pool.

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.

Required range: x > 0
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.