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

​
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

The name of the namespace. Namespaces group different limits together for better analytics. You might have a namespace for your public API and one for internal tRPC routes.

Example:

"email.outbound"

​
limit
integer
default:
100

The maximum number of keys to return

Required range: 1 <= x <= 100
Example:

100

​
cursor
string

Use this to fetch the next page of results. A new cursor will be returned in the response if there are more results.

Response

200
application/json
List of overrides for the given namespace.
​
overrides
object[]
required
​
total
integer
required

The total number of overrides for the namespace

​
cursor
string

The cursor to use for the next page of results, if no cursor is returned, there are no more results

Example:

"eyJrZXkiOiJrZXlfMTIzNCJ9"

Was this page helpful?

Suggest editsRaise issue
Get OverrideDelete Override