Skip to main content

Get Override

Retrieve the configuration of a specific rate limit override by identifier using the @unkey/ratelimit SDK. Check current custom limits.
1 min read

Request#

identifierstringrequired#

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

Warning

Either namespaceId or namespaceName is required. Not both.

namespaceIdstring#

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

namespaceNamestring#

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

Response#

result#
Show properties
idstringrequired#

Identifier of the override requested

identifierstringrequired#

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

limitnumberrequired#

How many requests may pass in a given window.

durationnumberrequired#

The window duration in milliseconds.