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.
Replace all direct permissions on a key in one step. Permissions not in the list are removed, and roles are untouched. Changes can take up to about 10 seconds to apply. Calls POST /v2/keys.setPermissions. See Managing key permissions.

Usage

Flags

string
required
Id of the key.
string[]
required
Comma-separated permission slugs that become the key’s full set of direct permissions. A slug that doesn’t exist yet is created.

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

Your root key must have write on unkey:v1:<workspace_id>:projects/<project_id>/keyspaces/<keyspace_id>/keys/<key_id>. Creating a missing permission slug also requires write on unkey:v1:<workspace_id>:projects/<project_id>/rbac/permissions/* in the key’s project. Setting existing permissions doesn’t require this additional grant. See Root key permissions. If the key write grant is missing, the request returns HTTP 403 when your root key can read the key. Otherwise, it returns the same HTTP 404 error as a missing key.

Examples

Set the exact permissions
Or send the whole request as JSON:
Raw body
Last modified on November 12, 2026