Sign in

v66

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0174265626.3 KB
deployments

Stop deployment

Stop a running preview deployment. Stopped deployments keep their configuration and can be resumed later with startDeployment.

The deployment must be ready and running, and must belong to a non-production environment; production deployments cannot be stopped. A deployment that is already draining from a previous stop is rejected with a precondition error.

Stopping is asynchronous: this endpoint only enqueues the stop and returns immediately. Poll getDeployment until the status reaches stopped.

Required Permissions

Your root key must have one of the following permissions:

  • environment.*.stop_deployment (to stop deployments in any environment)
  • environment.<environment_id>.stop_deployment (to stop deployments in a specific environment)
post/v2/deployments.stopDeployment

Request body

deploymentIdstring required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Example request

{
  "deploymentId": "proj_1234abcd"
}

Response

Stop accepted and enqueued. The deployment transitions to stopped asynchronously; poll getDeployment to observe the transition.

dataEmptyResponse required

Empty response object by design. A successful response indicates this operation was successfully executed.

Example response

{
  "meta": {
    "requestId": "req_123"
  }
}