Read Deployments
Query for deployments.
Headers
Body
x > 0
Filter for flows. Only flows matching all criteria will be returned.
Filter flow runs. Only flow runs matching all criteria will be returned
Filter task runs. Only task runs matching all criteria will be returned
Filter for deployments. Only deployments matching all criteria will be returned.
Filter work pools. Only work pools matching all criteria will be returned
Filter work queues. Only work queues matching all criteria will be returned
Defines deployment sorting options.
CREATED_DESC
, UPDATED_DESC
, NAME_ASC
, NAME_DESC
Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.
Response
The name of the deployment.
An optional version for the deployment.
A description for the deployment.
The flow id associated with the deployment.
Whether or not the deployment is paused.
A list of schedules for the deployment.
DEPRECATED: Prefer global_concurrency_limit
. Will always be None for backwards compatibility. Will be removed after December 2024.
The global concurrency limit object for enforcing the maximum number of flow runs that can be active at once.
The concurrency options for the deployment.
Overrides to apply to the base infrastructure block at runtime.
Parameters for flow runs scheduled by the deployment.
A list of tags for the deployment
A dictionary of key-value labels. Values can be strings, numbers, or booleans.
The work queue for the deployment. If no work queue is set, work will not be scheduled.
The last time the deployment was polled for status updates.
The parameter schema of the flow, including defaults.
The path to the working directory for the workflow, relative to remote storage or an absolute path.
Pull steps for cloning and running this deployment.
The path to the entrypoint for the workflow, relative to the path
.
The block document defining storage used for this flow.
The block document defining infrastructure to use for flow runs.
Optional information about the creator of this deployment.
Optional information about the updater of this deployment.
The name of the deployment's work pool.
Whether the deployment is ready to run flows.
READY
, NOT_READY
Whether or not the deployment should enforce the parameter schema.
Was this page helpful?