Skip to main content
PATCH
/
api
/
deployments
/
{id}
Update Deployment
curl --request PATCH \
  --url https://api.example.com/api/deployments/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": "<string>",
  "description": "<string>",
  "paused": false,
  "schedules": [
    {
      "active": true,
      "schedule": {
        "interval": 123,
        "anchor_date": "2023-11-07T05:31:56Z",
        "timezone": "America/New_York"
      },
      "max_scheduled_runs": 1,
      "parameters": {},
      "slug": "<string>"
    }
  ],
  "concurrency_limit": 1,
  "concurrency_options": {
    "collision_strategy": "ENQUEUE",
    "grace_period_seconds": 43230
  },
  "global_concurrency_limit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parameters": {},
  "parameter_openapi_schema": {},
  "tags": [
    "<string>"
  ],
  "work_queue_name": "<string>",
  "work_pool_name": "my-work-pool",
  "path": "<string>",
  "job_variables": {},
  "pull_steps": [
    {}
  ],
  "entrypoint": "<string>",
  "storage_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "infrastructure_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enforce_parameter_schema": true,
  "version_info": {
    "type": "<string>",
    "version": "<string>"
  }
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Headers

x-prefect-api-version
string

Path Parameters

id
string<uuid>
required

The deployment id

Body

application/json

Data used by the Prefect REST API to update a deployment.

version
string | null
description
string | null
paused
boolean
default:false

Whether or not the deployment is paused.

schedules
DeploymentScheduleUpdate · object[]

A list of schedules for the deployment.

concurrency_limit
integer | null

The deployment's concurrency limit.

Required range: x > 0
concurrency_options
ConcurrencyOptions · object

The deployment's concurrency options.

global_concurrency_limit_id
string<uuid> | null

The ID of the global concurrency limit to apply to the deployment.

parameters
Parameters · object

Parameters for flow runs scheduled by the deployment.

parameter_openapi_schema
Parameter Openapi Schema · object

The parameter schema of the flow, including defaults.

tags
string[]

A list of deployment tags.

Example:
["tag-1", "tag-2"]
work_queue_name
string | null
work_pool_name
string | null

The name of the deployment's work pool.

Example:

"my-work-pool"

path
string | null
job_variables
Job Variables · object

Overrides for the flow's infrastructure configuration.

pull_steps
Pull Steps · object[] | null
entrypoint
string | null
storage_document_id
string<uuid> | null
infrastructure_document_id
string<uuid> | null
enforce_parameter_schema
boolean | null

Whether or not the deployment should enforce the parameter schema.

version_info
VersionInfo · object

A description of this version of the deployment.

Response

Successful Response