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 a key with a new one. The new key copies the old one’s identity, permissions, roles, credits, rate limits, metadata, name, enabled state, and expiry. The expiry is the same date, so a key close to expiry gets a replacement close to expiry too. Use keys update to set a new one. The response has the new key’s plaintext, and you only see it once, so save it. The old key expires after --expiration milliseconds so callers have time to switch. It can keep verifying for about 10 seconds past that. Calls POST /v2/keys.rerollKey. See Rerolling keys.

Usage

Flags

integer
required
Milliseconds until the old key expires. The expiry is rounded up to the next whole minute, so the old key can work up to a minute longer than you asked. 0 expires it right away. The old key isn’t deleted. After it expires, it verifies with valid: false and code EXPIRED.
string
required
Id of the key to reroll.

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 credential must grant write on the original key: unkey:v1:<workspace_id>:projects/<project_id>/keyspaces/<keyspace_id>/keys/<key_id>#write. A matching wildcard grant also satisfies this requirement. The same permission applies to recoverable keys. See Root key permissions.

Examples

Reroll with a one day overlap
Reroll and revoke immediately
Or send the whole request as JSON:
Raw body
Last modified on November 12, 2026