Create Deployment
Gracefully creates a new deployment from the provided schema. If a deployment with the same name and flow_id already exists, the deployment is updated.
If the deployment has an active schedule, flow runs will be scheduled. When upserting, any scheduled runs from the existing deployment will be deleted.
Headers
Body
Data used by the Prefect REST API to create a deployment.
The name of the deployment.
The ID of the flow associated with the deployment.
Whether or not the deployment is paused.
A list of schedules for the deployment.
The deployment's concurrency limit.
x > 0The deployment's concurrency options.
Whether or not the deployment should enforce the parameter schema.
The parameter schema of the flow, including defaults.
Parameters for flow runs scheduled by the deployment.
A list of deployment tags.
A dictionary of key-value labels. Values can be strings, numbers, or booleans.
The name of the deployment's work pool.
Overrides for the flow's infrastructure configuration.
Response
The name of the deployment.
The flow id associated with the deployment.
An optional version for the deployment.
A description for 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?