Skip to main content
POST
Read Deployments

Headers

x-prefect-api-version
string

Body

application/json
offset
integer
default:0
Required range: x >= 0
flows
FlowFilter · object | null

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

flow_runs
FlowRunFilter · object | null

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

task_runs
TaskRunFilter · object | null

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

deployments
DeploymentFilter · object | null

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

work_pools
WorkPoolFilter · object | null

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

work_pool_queues
WorkQueueFilter · object | null

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

sort
enum<string>
default:NAME_ASC

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

Successful Response

id
string<uuid>
required
created
string<date-time> | null
required
updated
string<date-time> | null
required
name
string
required

The name of the deployment.

flow_id
string<uuid>
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
DeploymentSchedule · 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
GlobalConcurrencyLimitResponse · object | null

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

concurrency_options
ConcurrencyOptions · object | null

The concurrency options for the deployment.

job_variables
Job Variables · object

Overrides to apply to the base infrastructure block at runtime.

parameters
Parameters · object

Parameters for flow runs scheduled by the deployment.

tags
string[]

A list of tags for the deployment

Example:
labels
Labels · object

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

Example:
work_queue_name
string | null

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

work_queue_id
string<uuid> | null

The id of the work pool queue to which this deployment is assigned.

last_polled
string<date-time> | null

The last time the deployment was polled for status updates.

parameter_openapi_schema
Parameter Openapi Schema · object

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
CreatedBy · object | null

Optional information about the creator of this deployment.

updated_by
UpdatedBy · 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.