Read Work Pools

Read multiple work pools

Headers

x-prefect-api-version

string

Body

application/json

limit

integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

offset

integer

default:

0

Required range: x > 0

work_pools

object | null

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

Show child attributes

work_pools.id

object | null

Filter criteria for WorkPool.id

Show child attributes

work_pools.id.any_

string[] | null

A list of work pool ids to include

work_pools.name

object | null

Filter criteria for WorkPool.name

Show child attributes

work_pools.name.any_

string[] | null

A list of work pool names to include

work_pools.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

work_pools.type

object | null

Filter criteria for WorkPool.type

Show child attributes

work_pools.type.any_

string[] | null

A list of work pool types to include

Response

200 - application/json

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