Sign in
Deployments

Update Deployment

patch/api/deployments/{id}

Path parameters

idstring uuid required

The deployment id

The deployment id

Headers

x-prefect-api-versionstring

Request body

versionstring

An optional version for the deployment.

descriptionstring

A description for the deployment.

is_schedule_activeboolean

Whether or not the deployment schedule is active.

pausedboolean

Whether or not the deployment is paused.

parametersobject

Parameters for flow runs scheduled by the deployment.

tagsstring[]

A list of tags for the deployment

work_queue_namestring

The work queue for the deployment. If no work queue is set, work will not be scheduled.

work_pool_namestring

The name of the deployment's work pool.

pathstring

The path to the working directory for the workflow, relative to remote storage or an absolute path.

infra_overridesobject

Overrides to apply to the base infrastructure block at runtime.

entrypointstring

The path to the entrypoint for the workflow, relative to the path.

manifest_pathstring

The path to the flow's manifest file, relative to the chosen storage.

storage_document_idstring uuid

The block document defining storage used for this flow.

infrastructure_document_idstring uuid

The block document defining infrastructure to use for flow runs.

enforce_parameter_schemaboolean

Whether or not the deployment should enforce the parameter schema.

Example request

{
  "schedule": {
    "timezone": "America/New_York"
  },
  "schedules": [
    {
      "schedule": {
        "timezone": "America/New_York"
      }
    }
  ],
  "tags": [
    "tag-1",
    "tag-2"
  ],
  "work_pool_name": "my-work-pool"
}

Response

Successful Response

Changes