UNunkeyed
deployments

Stop deployment

Changed on

Stop a running deployment that is not the app's live production deployment. Stopped deployments keep their configuration. Preview deployments can be resumed later with startDeployment.

The deployment must be ready and running. Previous production deployments can be stopped, but stopping one removes instant rollback to it. 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 write permission on the deployment:

  • unkey:v1:<workspace_id>:projects/<project_id>/apps/<app_id>/environments/<environment_id>/deployments/<deployment_id>#write
post/v2/deployments.stopDeployment

Request

  • Base URL
    https://api.unkey.com
  • URL
    https://api.unkey.com/v2/deployments.stopDeployment
  • Auth
    HTTP bearer

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"
  }
}

Changes