Retrieve the configuration of a specific rate limit override by its identifier.
Use this to inspect override configurations, audit rate limiting policies, or debug rate limiting behavior.
Important: The identifier must match exactly as specified when creating the override, including wildcard patterns. This is case-sensitive -- for example, if the override was created for premium_*, you must use premium_* here, not a specific ID like premium_user1.
Required permissions:
ratelimit.*.read_override(to read overrides in any namespace)ratelimit.<namespace_id>.read_override(to read overrides in a specific namespace)
See the API reference for the full HTTP endpoint documentation.
Usage#
Flags#
The id or name of the namespace containing the override. Must be 1-512 characters.
The exact identifier pattern of the override to retrieve. This must match exactly as it was specified when creating the override, including any wildcards (*) that were part of the original pattern. Must be 1-512 characters.
Global Flags#
| Flag | Type | Description |
|---|---|---|
--root-key | string | Override root key ($UNKEY_ROOT_KEY) |
--api-url | string | Override API base URL (default: https://api.unkey.com) |
--config | string | Path to config file (default: ~/.unkey/config.toml) |
--output | string | Output format. Use json for raw JSON |
--body | string | Send this JSON string as the request body. You cannot combine it with request-building flags. |
Examples#
Output#
Default output shows the request ID, followed by the override configuration:
With --output=json, the full response envelope is returned: