Path Parameters
- idstringREQUIRED
The unique identifier for the specific endpoint
Body Parameters
- intervalstringREQUIRED
Specifies the time interval for the rate limit; valid values include second, minute or hour
- methodsarrayREQUIRED
An array of method names to which the rate limiter applies
- rateintegerREQUIRED
Specifies the maximum number of requests allowed for the specified methods within the defined interval
- limit_by_ipboolean
Set to true to apply the rate separately to each client IP. Set to false or omit this field to apply the rate to the endpoint as a whole (the existing behavior).
Returns
- dataobject
The data object which contains the following fields:
- idstring
A unique identifier for the rate limiter
- intervalstring
The time interval for the rate limit
- methodsarray
A list of methods the rate limiter applies to
- limit_by_ipboolean
Whether the rate limit applies separately to each client IP (true) or to the endpoint as a whole (false)
- rateinteger
The maximum number of requests allowed within the specified interval
- statusstring
The current status of the rate limiter
- createdstring
The timestamp when the rate limiter was created in second
- errorstring
A field containing an error message if any issue occurs