Skip to main content
You need a root key with the permissions listed on this page. Create one in the dashboard under Settings > Root Keys. See Permission reference for every permission.
Promote a deployment so it becomes the current deployment of its production . The live domains move to it, and the previous deployment stops after 30 minutes on standby. The deployment must be ready, in the production environment, and not shutting down, and its must already have a current deployment. You can’t promote the deployment that’s already current, except after a rollback. Then promoting it ends the rolled-back state and turns automatic promotion back on. The command returns right away. Poll get-deployment or list-deployments for the result. Promoting needs an active Compute plan. Without one the API answers 412 with The workspace has no active Compute plan. A workspace over its Compute spend cap gets The workspace is suspended by its Compute spend cap. Raise the spend limit to resume. See Compute plans.

​
Usage

​
Flags

​
string
required
ID of the deployment to promote.

​
Shared flags

Every unkey api 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 for the request. Falls back to UNKEY_ROOT_KEY, then to the config file written by unkey auth login. See CLI authentication.
​
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 file that unkey auth login writes. Falls back to UNKEY_CONFIG.
​
string
Output format. Falls back to UNKEY_OUTPUT. Set json to print the full response envelope (meta and data) for piping; any other value prints the request ID followed by data.

​
Required permissions

Your root key needs one of:
  • environment.*.promote_deployment (any environment)
  • environment.<environment_id>.promote_deployment (a specific environment)
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. See Root key permissions for the full catalog.

​
Examples

Promote a deployment:
Send the request body as JSON:

​
API endpoint

The command calls POST /v2/deployments.promoteDeployment 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

What promote and rollback change and when traffic switches.
Last modified on September 29, 2026