Skip to content

Latest commit

 

History

History
24 lines (19 loc) · 2.28 KB

v2ratelimitlimitrequestbody.md

File metadata and controls

24 lines (19 loc) · 2.28 KB

V2RatelimitLimitRequestBody

Example Usage

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

let value: V2RatelimitLimitRequestBody = {
  namespace: "sms.sign_up",
  duration: 305290,
  identifier: "<value>",
  limit: 99387,
};

Fields

Field Type Required Description Example
namespace string ✔️ The namespace name for the rate limit. sms.sign_up
cost number The cost of the request. Defaults to 1 if not provided.
duration number ✔️ The duration in milliseconds for the rate limit window.
identifier string ✔️ The identifier for the rate limit.
limit number ✔️ The maximum number of requests allowed.