Update Deployment

Headers

x-prefect-api-version

string

Path Parameters

id

string

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

object[]

A list of schedules for the deployment.

Show child attributes

schedules.active

boolean | null

Whether or not the schedule is active.

schedules.schedule

object | null

The schedule for the deployment.

• IntervalSchedule
• CronSchedule
• RRuleSchedule

Show child attributes

schedules.schedule.interval

number

required

schedules.schedule.anchor_date

string

Example:

"2020-01-01T00:00:00Z"

schedules.schedule.timezone

string | null

Example:

"America/New_York"

schedules.max_scheduled_runs

integer | null

The maximum number of scheduled runs for the schedule.

Required range: x > 0

schedules.parameters

object

A dictionary of parameter value overrides.

schedules.slug

string | null

A unique identifier for the schedule.

concurrency_limit

integer | null

The deployment's concurrency limit.

Required range: x > 0

concurrency_options

object | null

The deployment's concurrency options.

Show child attributes

concurrency_options.collision_strategy

enum<string>

required

Enumeration of concurrency collision strategies.

Available options:

ENQUEUE,

CANCEL_NEW

parameters

object | null

Parameters for flow runs scheduled by the deployment.

parameter_openapi_schema

object | null

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

object | null

Overrides for the flow's infrastructure configuration.

pull_steps

object[] | null

entrypoint

string | null

storage_document_id

string | null

infrastructure_document_id

string | null

enforce_parameter_schema

boolean | null

Whether or not the deployment should enforce the parameter schema.

Response

204

_mintlify/placeholder

Successful Response