GET
/
api
/
deployments
/
name
/
{flow_name}
/
{deployment_name}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "version": "<string>",
  "description": "<string>",
  "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "schedule": {
    "interval": 123,
    "anchor_date": "2020-01-01T00:00:00Z",
    "timezone": "America/New_York"
  },
  "is_schedule_active": true,
  "paused": false,
  "schedules": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "schedule": {
        "interval": 123,
        "anchor_date": "2020-01-01T00:00:00Z",
        "timezone": "America/New_York"
      },
      "active": true,
      "max_active_runs": 1,
      "max_scheduled_runs": 1,
      "catchup": false
    }
  ],
  "job_variables": {},
  "parameters": {},
  "tags": [
    "tag-1",
    "tag-2"
  ],
  "work_queue_name": "<string>",
  "last_polled": "2023-11-07T05:31:56Z",
  "parameter_openapi_schema": {},
  "path": "<string>",
  "pull_steps": [
    {}
  ],
  "entrypoint": "<string>",
  "storage_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "infrastructure_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "display_value": "<string>"
  },
  "updated_by": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "display_value": "<string>"
  },
  "work_pool_name": "<string>",
  "status": "READY",
  "enforce_parameter_schema": true
}

Headers

​
x-prefect-api-version
string

Path Parameters

​
flow_name
string
required

The name of the flow

​
deployment_name
string
required

The name of the deployment

Response

Successful Response

​
name
string
required

The name of the deployment.

​
flow_id
string<uuid>
required

The flow id associated with the deployment.

​
id
string<uuid>
​
created
string<date-time> | null
​
updated
string<date-time> | null
​
version
string | null

An optional version for the deployment.

​
description
string | null

A description for the deployment.

​
schedule
object | null

A schedule for the deployment. A schedule formed by adding interval increments to an anchor_date. If no anchor_date is supplied, the current UTC time is used. If a timezone-naive datetime is provided for anchor_date, it is assumed to be in the schedule's timezone (or UTC). Even if supplied with an IANA timezone, anchor dates are always stored as UTC offsets, so a timezone can be provided to determine localization behaviors like DST boundary handling. If none is provided it will be inferred from the anchor date.

NOTE: If the IntervalSchedule anchor_date or timezone is provided in a DST-observing timezone, then the schedule will adjust itself appropriately. Intervals greater than 24 hours will follow DST conventions, while intervals of less than 24 hours will follow UTC intervals. For example, an hourly schedule will fire every UTC hour, even across DST boundaries. When clocks are set back, this will result in two runs that appear to both be scheduled for 1am local time, even though they are an hour apart in UTC time. For longer intervals, like a daily schedule, the interval schedule will adjust for DST boundaries so that the clock-hour remains constant. This means that a daily schedule that always fires at 9am will observe DST and continue to fire at 9am in the local time zone.

Args: interval (datetime.timedelta): an interval to schedule on. anchor_date (DateTime, optional): an anchor date to schedule increments against; if not provided, the current timestamp will be used. timezone (str, optional): a valid timezone string.

​
is_schedule_active
boolean
default:true

Whether or not the deployment schedule is active.

​
paused
boolean
default:false

Whether or not the deployment is paused.

​
schedules
DeploymentSchedule · object[]

A list of schedules for the deployment.

​
job_variables
object

Overrides to apply to the base infrastructure block at runtime.

​
parameters
object

Parameters for flow runs scheduled by the deployment.

​
tags
string[]

A list of tags for the deployment

Examples:
["tag-1", "tag-2"]
​
work_queue_name
string | null

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

​
last_polled
string<date-time> | null

The last time the deployment was polled for status updates.

​
parameter_openapi_schema
object | null

The parameter schema of the flow, including defaults.

​
path
string | null

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

​
pull_steps
Pull Steps · object[] | null

Pull steps for cloning and running this deployment.

​
entrypoint
string | null

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

​
storage_document_id
string<uuid> | null

The block document defining storage used for this flow.

​
infrastructure_document_id
string<uuid> | null

The block document defining infrastructure to use for flow runs.

​
created_by
object | null

Optional information about the creator of this deployment.

​
updated_by
object | null

Optional information about the updater of this deployment.

​
work_pool_name
string | null

The name of the deployment's work pool.

​
status
enum<string> | null
default:NOT_READY

Whether the deployment is ready to run flows. Enumeration of deployment statuses.

Available options:
READY,
NOT_READY
​
enforce_parameter_schema
boolean
default:true

Whether or not the deployment should enforce the parameter schema.