Skip to main content
Create a root key with the permissions listed on this page under Root Keys in the dashboard sidebar. CLI commands can instead use a session from unkey login with the required permissions. See Permission reference for every permission.
Stop a running deployment and free its compute resources. The deployment must be ready and must not be the app’s live production deployment. You can stop a previous production deployment, but this removes instant rollback to it. Stopped deployments keep their configuration. You can resume preview deployments with unkey deployments start. Stopping a deployment that’s still shutting down from an earlier stop returns a precondition error. The command returns before the instances are gone. Poll unkey deployments get until the status is stopped.

Usage

Flags

string
required
ID of the running deployment to stop.

Shared flags

Every resource command accepts these; CLI output and shared flags describes them in full.
string
A JSON document sent as the request body instead of building it from the flags above. It is mutually exclusive with the request-building flags, and unknown fields are rejected locally. See Send a raw body.
string
Root key used for the request. Falls back to UNKEY_ROOT_KEY, then stored credentials, including a CLI session. See CLI authentication for the full precedence order.
string
default:"https://api.unkey.com"
Base URL of the API. Falls back to UNKEY_API_BASE_URL. You don’t normally need to set it.
string
default:"~/.unkey/config.toml"
Path of the TOML config file. Falls back to UNKEY_CONFIG. An explicit --config takes precedence over a stored CLI session. Browser login stores a session, not a root key in this file. See CLI authentication.
enum
default:"human"
Use human (default) for name-first summary tables and single-response trees, or json for the unchanged full response envelope, including all fields and pagination. Trees wrap long values without truncation. Terminal tables use relative timestamps and may shorten display names and descriptions, but never identifiers, slugs, or credentials. Redirected human output keeps complete values and uses RFC3339 UTC timestamps. Falls back to UNKEY_OUTPUT; other values are rejected. --json also selects JSON output. Add --debug to print the request ID to stderr. See Output formats.
boolean
Print the successful response’s request ID to stderr, separate from stdout.
boolean
Print the full response as JSON. Takes precedence over a valid --output or UNKEY_OUTPUT value.

Required permissions

Your root key needs write on the deployment:
  • unkey:v1:<workspace_id>:projects/<project_id>/apps/<app_id>/environments/<environment_id>/deployments/<deployment_id>#write
If the deployment doesn’t exist or your key doesn’t have the permission, you get the same 404: The requested deployment does not exist. If your key can read the deployment, you get a 403 that names the missing permission instead. See Root key permissions for the full catalog.

Examples

Stop a preview deployment:
Send the request body as JSON:

API endpoint

The command calls POST /v2/deployments.stopDeployment and prints its response. The request fields carry the same names as the flags in camelCase, which is the shape --body expects.

Production and preview

Stop and start in preview environments and the automatic stop timers.
Last modified on October 30, 2026