GET
/
v1
/
ratelimits.getOverride
curl --request GET \
  --url https://api.unkey.dev/v1/ratelimits.getOverride \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "identifier": "<string>",
  "limit": 123,
  "duration": 123,
  "async": true
}

​
Changelog

DateChanges
Nov 25 2024Introduced endpoint

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
namespaceId
string

The id of the namespace. Either namespaceId or namespaceName must be provided

Example:

"rlns_1234"

​
namespaceName
string

Namespaces group different limits together for better analytics. You might have a namespace for your public API and one for internal tRPC routes. Wildcards can also be used, more info can be found at https://www.unkey.com/docs/ratelimiting/overrides#wildcard-rules

Example:

"email.outbound"

​
identifier
string
required

Identifier of your user, this can be their userId, an email, an ip or anything else. Wildcards ( * ) can be used to match multiple identifiers, More info can be found at https://www.unkey.com/docs/ratelimiting/overrides#wildcard-rules

Example:

"user_123"

Response

200
application/json
Details of the override for the given identifier
​
id
string
required
​
identifier
string
required
​
limit
integer
required
​
duration
integer
required
​
async
boolean | null

Was this page helpful?

Suggest editsRaise issue
Set OverrideList Overrides