v1

latestOpenAPI 3.1.0raw.githubusercontent.com2024-11-08170291390.5 KB

Deployments

Update Deployment

patch/api/deployments/{id}

Path parameters

idstring uuid required

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