Set Override

Request

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

number

required

How many requests may pass in a given window.

number

required

The window duration in milliseconds.

Either namespaceId or namespaceName is required. Not both.

string

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

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

Response

Hide properties

string

required

The id of the override that was set.

const { meta, data } = await unkey.setOverride({
    identifier: "user_123",
    limit: 10,
    duration: 60000,
    namespaceName: "email.outbound",
    async: true
})

const { meta, data } = await unkey.setOverride({
  identifier: "user_123",
  limit: 5,
  duration: 50000,
  namespaceId: "rlns_1234",
  async: false,
});

{
  result: {
     overrideId: 'rlor_12345'
  }
}

Last modified on May 26, 2026

Get OverrideRetrieve the configuration of a specific rate limit override by identifier using the @unkey/ratelimit SDK. Check current custom limits.

⌘I

const { meta, data } = await unkey.setOverride({
    identifier: "user_123",
    limit: 10,
    duration: 60000,
    namespaceName: "email.outbound",
    async: true
})

const { meta, data } = await unkey.setOverride({
  identifier: "user_123",
  limit: 5,
  duration: 50000,
  namespaceId: "rlns_1234",
  async: false,
});

{
  result: {
     overrideId: 'rlor_12345'
  }
}

Official Libraries

Community Libraries

Request

Response

​Request

​Response

Request

Response