You need a root key with the permissions listed on this page. Create one in the dashboard under Settings > Root Keys. See Permission reference for every permission.
premium_user_123 returns the premium_* override. If an identifier matches more than one pattern, there’s no guarantee which one you see. (ratelimit delete-override doesn’t match patterns. It needs the exact stored identifier.)
A namespace that doesn’t exist or was deleted returns 404 err:unkey:data:ratelimit_namespace_not_found. An identifier with no override returns a different 404. Calls POST /v2/ratelimit.getOverride. See Rate limit overrides.
Usage
Flags
string
required
The identifier to resolve. Pass a concrete identifier to see which override applies to it, or the pattern itself, such as
premium_*, to read that override directly.string
required
Namespace id or name.
Shared flags
Everyunkey api command takes these. See CLI output and shared flags.
string
Root key used for the request. Falls back to
UNKEY_ROOT_KEY, then to the key stored by unkey auth login.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 config file written by
unkey auth login. Falls back to UNKEY_CONFIG.string
Output format. Falls back to
UNKEY_OUTPUT. json prints the full response. Any other value prints the request ID and data.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
ratelimit.*.read_override or ratelimit.<namespace_id>.read_override. Without the permission you get a 404, not a 403, so the response doesn’t reveal whether the resource exists. See Root key permissions.
Examples
Read
Raw body