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.

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.

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.

Editing deployments

You may edit or update an existing deployment within the Prefect UI or via the CLI by applying changes from an edited deployment YAML file.

To change a deployment via the CLI, edit the deployment YAML file, then use the prefect deployment apply CLI command. If a deployment already exists, it will be updated rather than creating a new deployment. See the Deployments documentation for details.