Update Work Pool

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

PATCH

api

work_pools

{name}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

x-prefect-api-version

string

name

string

required

The work pool name

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.

Show child attributes

storage_configuration.bundle_upload_step

Bundle Upload Step · object

The step to use for uploading bundles to storage.

storage_configuration.bundle_execution_step

Bundle Execution Step · object

The step to use for executing bundles.

storage_configuration.default_result_storage_block_id

string<uuid> | null

The block document ID of the default result storage block.

Successful Response

⌘I