Skip to main content

Documentation Index

Fetch the complete documentation index at: https://unkey.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve a paginated list of all rate limit overrides in a namespace. Use this to audit rate limiting policies, build admin dashboards, or manage override configurations. Important: Results are paginated. Use the cursor parameter to retrieve additional pages when more results are available. Required permissions:
  • ratelimit.*.read_override or ratelimit.<namespace_id>.read_override
See the API reference for the full HTTP endpoint documentation.

​
Usage

unkey api ratelimit list-overrides [flags]

​
Flags

​
--namespace
string
required
The ID or name of the rate limit namespace to list overrides for. Must be 1-255 characters.
​
--limit
integer
Maximum number of override entries to return in a single response. Use this to control response size and loading performance.
  • Lower values (10-20): Better for UI displays and faster response times
  • Higher values (50-100): Better for data exports or bulk operations
  • Default (10): Suitable for most dashboard views
Results exceeding this limit will be paginated, with a cursor provided for fetching subsequent pages. Must be between 1 and 100.
​
--cursor
string
Pagination cursor from a previous response. Include this when fetching subsequent pages of results. Each response containing more results than the requested limit will include a cursor value that can be used here.

​
Global Flags

FlagTypeDescription
--root-keystringOverride root key ($UNKEY_ROOT_KEY)
--api-urlstringOverride API base URL (default: https://api.unkey.com)
--configstringPath to config file (default: ~/.unkey/config.toml)
--outputstringOutput format. Use json for raw JSON

​
Examples

unkey api ratelimit list-overrides --namespace=api.requests

​
Output

Default output shows the request ID with latency, followed by the list of overrides: 
req_2cGKbMxRyIzhCxo1Idjz8q (took 38ms)

{
  "overrides": [
    {
      "overrideId": "ovr_1234567890abcdef",
      "identifier": "premium_user_123",
      "limit": 1000,
      "duration": 60000
    },
    {
      "overrideId": "ovr_2345678901bcdefg",
      "identifier": "premium_*",
      "limit": 500,
      "duration": 60000
    }
  ],
  "cursor": "cursor_eyJsYXN0SWQiOiJvdnJfMmhGTGNOeVN6SnppRHlwMkpla2E5ciJ9"
}
With --output=json, the full response envelope is returned: 
{
  "meta": {
    "requestId": "req_2cGKbMxRyIzhCxo1Idjz8q"
  },
  "data": {
    "overrides": [
      {
        "overrideId": "ovr_1234567890abcdef",
        "identifier": "premium_user_123",
        "limit": 1000,
        "duration": 60000
      },
      {
        "overrideId": "ovr_2345678901bcdefg",
        "identifier": "premium_*",
        "limit": 500,
        "duration": 60000
      }
    ],
    "cursor": "cursor_eyJsYXN0SWQiOiJvdnJfMmhGTGNOeVN6SnppRHlwMkpla2E5ciJ9"
  }
}
Last modified on May 6, 2026