Skip to main content
POST
Requires version 2.0.1 or later of the Archetype platform.

Overview

This endpoint stops a deployment and returns it. The deployment becomes stopped, and every session on it that has not ended becomes cancelled, its run stopped. No session can be opened on a stopped deployment. You can stop a deployment that is deploying or ready. Stopping is final: to run the package again, deploy it again. Once it is stopped, you can delete it after deleting its sessions.

Request

string
required
Deployment dpl_ id.

Response

Returns 200 OK with the stopped deployment, with the same fields as Get Deployment returns. Its status is stopped and stopped_at is set.

Important Notes

  • A 409 means the deployment has already ended as stopped or failed.
  • A 403 means you can see the deployment’s project but cannot modify it.
  • A 404 means the deployment does not exist, belongs to another organization, or is in a project you cannot see.
  • Stopping cancels the deployment’s pending and running sessions. Each one records a cancelled: its deployment was stopped event in List Session Events.