POST
/
v2
/
ratelimit.getOverride
Python (SDK)
from unkey.py import Unkey


with Unkey(
    root_key="<YOUR_BEARER_TOKEN_HERE>",
) as unkey:

    res = unkey.ratelimit.get_override(namespace="<value>", identifier="premium_user_123")

    # Handle response
    print(res)
{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "overrideId": "<string>",
    "duration": 1001,
    "identifier": "<string>",
    "limit": 1
  }
}

Authorizations

​
Authorization
string
header
required

Unkey uses API keys (root keys) for authentication. These keys authorize access to management operations in the API. To authenticate, include your root key in the Authorization header of each request:

Authorization: Bearer unkey_123

Root keys have specific permissions attached to them, controlling what operations they can perform. Key permissions follow a hierarchical structure with patterns like resource.resource_id.action (e.g., apis.*.create_key, apis.*.read_api). Security best practices:

  • Keep root keys secure and never expose them in client-side code
  • Use different root keys for different environments
  • Rotate keys periodically, especially after team member departures
  • Create keys with minimal necessary permissions following least privilege principle
  • Monitor key usage with audit logs.

Body

application/json

Gets the configuration of an existing rate limit override. Use this to retrieve details about custom rate limit rules that have been created for specific identifiers within a namespace.

This endpoint is useful for:

  • Verifying override configurations
  • Checking current limits for specific entities
  • Auditing rate limit policies
  • Debugging rate limiting behavior
  • Retrieving override settings for modification

Response

200
application/json

Override found and returned successfully.

The response is of type object.