GET
/
api
/
work_pools
/
{name}

Headers

x-prefect-api-version
string

Path Parameters

name
string
required

The work pool name

Response

200 - application/json

An ORM representation of a work pool

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.