GET
/
api
/
deployments
/
{id}
{
  "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",
  "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_scheduled_runs": 1,
      "parameters": {},
      "slug": "<string>"
    }
  ],
  "concurrency_limit": 123,
  "global_concurrency_limit": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "active": true,
    "name": "<string>",
    "limit": 123,
    "active_slots": 123,
    "slot_decay_per_second": 2
  },
  "concurrency_options": {
    "collision_strategy": "ENQUEUE"
  },
  "job_variables": {},
  "parameters": {},
  "tags": [
    "tag-1",
    "tag-2"
  ],
  "labels": {
    "key": "value1",
    "key2": 42
  },
  "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

​
id
string
required

The deployment id

Response

200
application/json
Successful Response
​
id
string
required
​
created
string | null
required
​
updated
string | null
required
​
name
string
required

The name of the deployment.

​
flow_id
string
required

The flow id associated with the deployment.

​
version
string | null

An optional version for the deployment.

​
description
string | null

A description for the deployment.

​
paused
boolean
default:
false

Whether or not the deployment is paused.

​
schedules
object[]

A list of schedules for the deployment.

​
concurrency_limit
integer | null
deprecated

DEPRECATED: Prefer global_concurrency_limit. Will always be None for backwards compatibility. Will be removed after December 2024.

​
global_concurrency_limit
object | null

The global concurrency limit object for enforcing the maximum number of flow runs that can be active at once.

​
concurrency_options
object | null

The concurrency options 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

​
labels
object

A dictionary of key-value labels. Values can be strings, numbers, or booleans.

​
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 | 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
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 | null

The block document defining storage used for this flow.

​
infrastructure_document_id
string | 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.

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

Whether or not the deployment should enforce the parameter schema.

Was this page helpful?

Create DeploymentDelete Deployment