const { result, error } = await unkey.ratelimits.getOverride({
  identifier:"user.example",
  namespaceName: "email.outbound"
});
if (error) {
  // handle potential network or bad request error
  // a link to our docs will be in the `error.docs` field
  console.error(error.message);
  return;
}

console.log(result);
{
  "result": {
    "id": "rlor_4567",
    "identifier": "user.example",
    "limit": 10,
    "duration": 60000,
    "async": false
  }
}
const { result, error } = await unkey.ratelimits.getOverride({
  identifier:"user.example",
  namespaceName: "email.outbound"
});
if (error) {
  // handle potential network or bad request error
  // a link to our docs will be in the `error.docs` field
  console.error(error.message);
  return;
}

console.log(result);
{
  "result": {
    "id": "rlor_4567",
    "identifier": "user.example",
    "limit": 10,
    "duration": 60000,
    "async": false
  }
}

Request

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
Either namespaceId or namespaceName is required. Not both.
namespaceId
string
The id of the namespace. Either namespaceId or namespaceName must be provided
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

Response

result