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.
Give one identifier, or a wildcard pattern, its own limit and window. It’s used instead of the values sent to ratelimit limit. Setting it again replaces the old one. An exact identifier beats a pattern. If an identifier matches two patterns, such as premium_* and *_eu, there’s no guarantee which applies, so keep patterns from overlapping. Calls POST /v2/ratelimit.setOverride. See Rate limit overrides.

Usage

Flags

integer
required
Window length in milliseconds, at least 1000. It doesn’t have to match the window the caller sends.
string
required
Identifier to override, or a pattern with * such as premium_*.
integer
required
Maximum operations allowed in the window. The API accepts 0, but checks against it then fail with a server error instead of being denied. To nearly block an identifier, use 1 with a long --duration.
string
required
Namespace id or name. The namespace must already exist.

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

Creating an override requires unkey:v1:<workspace_id>:projects/<project_id>/ratelimits/namespaces/<namespace_id>/overrides/*#write. To update an override, you can replace * with its override ID. See Root key permissions.

Examples

Raise one user's limit
Pattern override
Or send the whole request as JSON:
Raw body
Last modified on November 11, 2026