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.
create-deployment, promote-deployment, rollback-deployment, start-deployment, or stop-deployment, which all return before the work is done. The statuses are explained in Deployments.
Usage
Flags
string
required
Deployment ID, for example
d_1234abcd.Shared flags
Everyunkey 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.*.read_deployment(any environment)environment.<environment_id>.read_deployment(a specific environment)
The requested deployment does not exist. See Root key permissions for the full catalog.
Examples
Get a deployment:API endpoint
The command callsPOST /v2/deployments.getDeployment and prints its response. The request fields carry the same names as the flags in camelCase, which is the shape --body expects.