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

infra_overridesobject

Deprecated field. Use job_variables instead.

versionstring
descriptionstring
is_schedule_activeboolean

Whether the schedule is active.

pausedboolean

Whether or not the deployment is paused.

parametersobject

Parameters for flow runs scheduled by the deployment.

tagsstring[]

A list of deployment tags.

work_queue_namestring
work_pool_namestring

The name of the deployment's work pool.

pathstring
job_variablesobject

Overrides for the flow's infrastructure configuration.

entrypointstring
manifest_pathstring
storage_document_idstring uuid
infrastructure_document_idstring uuid
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

Changed in 4 of the 50 revisions of this API.16

  • e3ee4e0af3973See the full diff
    • ○

      added the new optional request property schedules/items/catchup

      new-optional-request-property

    • ○

      added the new optional request property schedules/items/max_active_runs

      new-optional-request-property

    • ○

      added the new optional request property schedules/items/max_scheduled_runs

      new-optional-request-property

  • 9bf4f938a0701See the full diff
    • ○

      added the new optional request property job_variables

      new-optional-request-property

  • 1300477de63f1See the full diff
    • ▲

      the request property schedules/items/schedule became required

      request-property-became-required

  • f5e6e917c9242See the full diff
    • ○

      added the new optional request property paused

      new-optional-request-property

    • ○

      added the new optional request property schedules

      new-optional-request-property