Scale Intelligence■ Docs
Docs / The model / RateLimit

RateLimit.

Requests allowed per window for one token, and per client address for the sign-in routes; over it the answer is 429 with Retry-After

Figure 1RateLimitspecified
RATELIMITparameter at platform scopesubjectenum:token|client-addressrequestscountwindowdurationburstcountoptionalpoints at no other object
RateLimit is a parameter at platform scope. The drawing shows its fields and the objects that they point at.
kind
parameter
scope
platform
key
the token or the client address
store
postgres
family
network

Fields#

fieldtyperequirednote
subjectone of token | client-addressyes
requestscountyes
windowdurationyes
burstcountno

Routes that use it#

No route takes or returns RateLimit directly. The record holds it, and the objects that point at it reach it.