Sign in
Deployments

Read Deployment

Get a deployment by id.

get/api/deployments/{id}

Path parameters

idstring uuid required

The deployment id

The deployment id

Headers

x-prefect-api-versionstring

Response

Successful Response

idstring uuid
createdstring date-time
updatedstring date-time
infra_overridesobject

Deprecated field. Use job_variables instead.

namestring required

The name of the deployment.

versionstring

An optional version for the deployment.

descriptionstring

A description for the deployment.

flow_idstring uuid required

The flow id associated with the deployment.

is_schedule_activeboolean

Whether or not the deployment schedule is active.

pausedboolean

Whether or not the deployment is paused.

job_variablesobject

Overrides to apply to the base infrastructure block at runtime.

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.

last_polledstring date-time

The last time the deployment was polled for status updates.

parameter_openapi_schemaobject

The parameter schema of the flow, including defaults.

pathstring

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

pull_stepsobject[]

Pull steps for cloning and running this deployment.

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.

work_pool_namestring

The name of the deployment's work pool.

status'READY' | 'NOT_READY'

Enumeration of deployment statuses.

enforce_parameter_schemaboolean

Whether or not the deployment should enforce the parameter schema.

Example response

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

Changes

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

  • e3ee4e0af3973See the full diff
    • ○

      added the optional property schedules/items/catchup to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property schedules/items/max_active_runs to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property schedules/items/max_scheduled_runs to the response with the 200 status

      response-optional-property-added

  • 9bf4f938a0701See the full diff
    • ○

      added the optional property job_variables to the response with the 200 status

      response-optional-property-added

  • f5252435d1572See the full diff
    • ○

      the response property flow_id became required for the status 200

      response-property-became-required

    • ○

      the response property name became required for the status 200

      response-property-became-required

  • f5e6e917c9242See the full diff
    • ○

      added the optional property paused to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property schedules to the response with the 200 status

      response-optional-property-added