Read Deployments

POST

api

deployments

filter

[
  {
    "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

Body

application/json

offset

integer

default:

Required range: x > 0

flows

object

Filter for flows. Only flows matching all criteria will be returned.

flow_runs

object

Filter flow runs. Only flow runs matching all criteria will be returned

flow_runs.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.id

object | null

Filter criteria for FlowRun.id

flow_runs.name

object | null

Filter criteria for FlowRun.name

flow_runs.tags

object | null

Filter criteria for FlowRun.tags

flow_runs.deployment_id

object | null

Filter criteria for FlowRun.deployment_id

flow_runs.work_queue_name

object | null

Filter criteria for `FlowRun.work_queue_name

flow_runs.state

object | null

Filter criteria for FlowRun.state

flow_runs.flow_version

object | null

Filter criteria for FlowRun.flow_version

flow_runs.start_time

object | null

Filter criteria for FlowRun.start_time

flow_runs.end_time

object | null

Filter criteria for FlowRun.end_time

flow_runs.expected_start_time

object | null

Filter criteria for FlowRun.expected_start_time

flow_runs.next_scheduled_start_time

object | null

Filter criteria for FlowRun.next_scheduled_start_time

flow_runs.parent_flow_run_id

object | null

Filter criteria for subflows of the given flow runs

flow_runs.parent_task_run_id

object | null

Filter criteria for FlowRun.parent_task_run_id

flow_runs.idempotency_key

object | null

Filter criteria for FlowRun.idempotency_key

task_runs

object

Filter task runs. Only task runs matching all criteria will be returned

task_runs.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

task_runs.id

object | null

Filter criteria for TaskRun.id

task_runs.name

object | null

Filter criteria for TaskRun.name

task_runs.tags

object | null

Filter criteria for TaskRun.tags

task_runs.state

object | null

Filter criteria for TaskRun.state

task_runs.start_time

object | null

Filter criteria for TaskRun.start_time

task_runs.expected_start_time

object | null

Filter criteria for TaskRun.expected_start_time

task_runs.subflow_runs

object | null

Filter criteria for TaskRun.subflow_run

task_runs.flow_run_id

object | null

Filter criteria for TaskRun.flow_run_id

deployments

object

Filter for deployments. Only deployments matching all criteria will be returned.

deployments.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

deployments.id

object | null

Filter criteria for Deployment.id

deployments.name

object | null

Filter criteria for Deployment.name

deployments.flow_or_deployment_name

object | null

Filter criteria for Deployment.name or Flow.name

deployments.paused

object | null

Filter criteria for Deployment.paused

deployments.tags

object | null

Filter criteria for Deployment.tags

deployments.work_queue_name

object | null

Filter criteria for Deployment.work_queue_name

deployments.concurrency_limit

object | null

deprecated

DEPRECATED: Prefer Deployment.concurrency_limit_id over Deployment.concurrency_limit. If provided, will be ignored for backwards-compatibility. Will be removed after December 2024.

work_pools

object

Filter work pools. Only work pools matching all criteria will be returned

work_pool_queues

object

Filter work queues. Only work queues matching all criteria will be returned

sort

enum<string>

Defines deployment sorting options.

Available options:

CREATED_DESC,

UPDATED_DESC,

NAME_ASC,

NAME_DESC

limit

integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

200

application/json

Successful Response

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?

Read Deployment By Name Paginate Deployments

[
  {
    "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
  }
]

APIs & SDK

Headers

Body

Response