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.
List the keys of an API. Results come in pages. Pass the cursor from one response to get the next page. Calls POST /v2/apis.listKeys. See Listing keys.

Usage

Flags

string
required
Id of the API whose keys to list.
string
Cursor from the previous response’s pagination.cursor.
boolean
default:"false"
Include the plaintext key in each result. Only keys created with --recoverable have one, and the root key needs decrypt_key. The call fails with 412 unless the keyspace has key encryption turned on, which only we can do, through a support request.
string
Return only keys linked to the identity with this external id. An external id that matches no identity returns an empty page, not an error.
integer
Maximum number of keys per page. 1 to 100. Defaults to 100.
boolean
default:"false"
When true, reads keys and their identities from the primary database to avoid replica lag. When false or omitted, reads from a replica, which may not reflect recent changes. Primary reads can have higher latency, depending on your region.

Shared flags

Every resource command takes these. See CLI output and shared flags.
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.
string
Send this JSON as the whole request body instead of using the command’s flags. You can’t combine it with them.

Required permissions

api.*.read_key or api.<apiId>.read_key, together with api.*.read_api or api.<apiId>.read_api. --decrypt also needs api.*.decrypt_key or api.<apiId>.decrypt_key. Without the permission you get a 404, so the response doesn’t reveal whether the API exists. If your key can read the keys but not decrypt them, --decrypt fails with a 403 that names the missing permission. See Root key permissions.

Examples

First page
Keys of one identity
Or send the whole request as JSON:
Raw body
Last modified on October 28, 2026