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.
Retrieve one of an , including its build, runtime, health check, and region settings. Each of --project, --app, and --environment takes an ID or a slug.

Usage

Flags

string
required
App ID or slug.
string
required
Environment ID or slug, for example production or preview.
string
required
ID or slug. Both forms resolve to the same project.

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 one of:
  • environment.*.read_environment (any environment)
  • environment.<environment_id>.read_environment (a specific environment)
If the environment doesn’t exist or your key doesn’t have the permission, you get the same 404: The requested environment does not exist. See Root key permissions for the full catalog.

Examples

Get the production environment:
Print only the runtime settings:

API endpoint

The command calls POST /v2/environments.getEnvironment and prints its response. The request fields carry the same names as the flags in camelCase, which is the shape --body expects.
Last modified on October 28, 2026