Deployments
Update Deployment
PATCH
/
api
/
deployments
/
{id}
Headers
x-prefect-api-version
string
Path Parameters
id
string
requiredThe 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: falseWhether or not the deployment is paused.
schedules
object[]
A list of schedules for the deployment.
concurrency_limit
integer | null
The deployment's concurrency limit.
concurrency_options
object | null
The deployment's concurrency options.
parameters
object | null
Parameters for flow runs scheduled by the deployment.
tags
string[]
A list of deployment tags.
work_queue_name
string | null
work_pool_name
string | null
The name of the deployment's work pool.
path
string | null
job_variables
object | null
Overrides for the flow's infrastructure configuration.
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.
Was this page helpful?