Skip to main content
POST
/
work_pools
Create Work Pool
curl --request POST \
  --url https://api.example.com/work_pools/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "type": "prefect-agent",
  "base_job_template": {},
  "is_paused": false,
  "concurrency_limit": 1,
  "storage_configuration": {
    "bundle_upload_step": {},
    "bundle_execution_step": {},
    "default_result_storage_block_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "type": "<string>",
  "description": "<string>",
  "base_job_template": {},
  "is_paused": false,
  "concurrency_limit": 1,
  "status": "READY",
  "default_queue_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "storage_configuration": {
    "bundle_upload_step": {},
    "bundle_execution_step": {},
    "default_result_storage_block_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Headers

​
x-prefect-api-version
string

Body

application/json

Data used by the Prefect REST API to create a work pool.

​
name
string
required

The name of the work pool.

Pattern: ^[^/%&><]+$
​
description
string | null

The work pool description.

​
type
string
default:prefect-agent

The work pool type.

​
base_job_template
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
​
storage_configuration
WorkPoolStorageConfiguration · object

The storage configuration for the work pool.

Response

Successful Response

An ORM representation of a work pool

​
id
string<uuid>
required
​
created
string<date-time> | null
required
​
updated
string<date-time> | null
required
​
name
string
required

The name of the work pool.

Pattern: ^[^/%&><]+$
​
type
string
required

The work pool type.

​
description
string | null

A description of the work pool.

​
base_job_template
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<uuid> | null

The id of the pool's default queue.

​
storage_configuration
WorkPoolStorageConfiguration · object

The storage configuration for the work pool.