POST
/
v2
/
ratelimit.getOverride
Go (SDK)
package main

import(
	"context"
	"os"
	unkey "github.com/unkeyed/sdks/api/go/v2"
	"github.com/unkeyed/sdks/api/go/v2/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := unkey.New(
        unkey.WithSecurity(os.Getenv("UNKEY_ROOT_KEY")),
    )

    res, err := s.Ratelimit.GetOverride(ctx, components.V2RatelimitGetOverrideRequestBody{
        Namespace: "<value>",
        Identifier: "premium_user_123",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2RatelimitGetOverrideResponseBody != nil {
        // handle response
    }
}
{
  "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
​
namespace
string
required

The id or name of the namespace containing the override.

Required string length: 1 - 255
​
identifier
string
required

The exact identifier pattern for the override you want to retrieve. This must match exactly as it was specified when creating the override.

Important notes:

  • This is case-sensitive and must match exactly
  • Include any wildcards (*) that were part of the original pattern
  • For example, if the override was created for 'premium_', you must use 'premium_' here, not a specific ID like 'premium_user1'

This field is used to look up the specific override configuration for this pattern.

Required string length: 1 - 255

Response

Override found and returned successfully.

​
meta
object
required

Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The requestId is particularly important when troubleshooting issues with the Unkey support team.

​
data
object
required