Skip to main content
PATCH
/
work_pools
/
{name}
Update Work Pool
curl --request PATCH \
  --url https://api.example.com/work_pools/{name} \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "is_paused": true,
  "base_job_template": {},
  "concurrency_limit": 1,
  "storage_configuration": {
    "bundle_upload_step": {},
    "bundle_execution_step": {},
    "default_result_storage_block_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.prefect.io/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-prefect-api-version
string

Path Parameters

​
name
string
required

The work pool name

Body

application/json

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

​
description
string | null
​
is_paused
boolean | null
​
base_job_template
Base Job Template · object
​
concurrency_limit
integer | null
Required range: x >= 0
​
storage_configuration
WorkPoolStorageConfiguration · object

The storage configuration for the work pool.

Response

Successful Response