Skip to content

Deployments

Deployments encapsulates instructions for running a flow, allowing it to be scheduled and triggered via API.

The Deployments page in the UI displays any deployments that have been created on the current API instance or Prefect Cloud workspace.

Viewing deployments in the Prefect UI

Selecting the toggle next to a deployment pauses the run schedule for the deployment, if the deployment specifies a schedule.

The button next to the pause toggle provides commands to copy the deployment ID or delete the deployment. Note that deleting the deployment only removes the deployment object from the API, along with any of its scheduled flow runs. It does not affect the source files for your flow or deployment specification.

Selecting a flow name displays details about the flow. See Flows and Tasks for more information.

Selecting a deployment name displays details about the deployment. The Overview tab displays general details of the deployment.

Viewing details of a deployment in the Prefect UI

Selecting the Run button starts an ad-hoc flow run for the deployment.

Selecting the toggle next to a deployment pauses the run schedule for the deployment, if the deployment specifies a schedule.

The button next to the toggle provides commands to copy the deployment ID or delete the deployment.

The Parameters tab displays any parameters specified for the deployment.

Viewing parameters of a deployment in the Prefect UI

Currently, you cannot edit the deployment within the UI. To change a deployment, edit the deployment specification and use the prefect deployment create CLI command. If a deployment already exists for the specification on the API, it will be updated rather than creating a new deployment. See the Deployments documentation for details.