ratelimitoverride.md

RatelimitOverride

Example Usage

import { RatelimitOverride } from "@unkey/api/models/components";

let value: RatelimitOverride = {
  namespaceId: "<id>",
  overrideId: "<id>",
  duration: 528055,
  identifier: "<value>",
  limit: 15525,
};

Fields

Field	Type	Required	Description
namespaceId	string	✔️	The id of the namespace.
overrideId	string	✔️	The id of the override.
duration	number	✔️	The duration in milliseconds for the rate limit window.
identifier	string	✔️	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
limit	number	✔️	The maximum number of requests allowed.