Skip to main content

list-overrides

List all rate limit overrides in a namespace using the Unkey CLI. View paginated results of custom limits applied to specific identifiers.
2 min read

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
Note

See the API reference for the full HTTP endpoint documentation.

Usage#

Flags#

--namespacestringrequired#

The ID or name of the rate limit namespace to list overrides for. Must be 1-512 characters.

--limitinteger#

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.

--cursorstring#

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
--bodystringSend 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 list of overrides:

With --output=json, the full response envelope is returned: