Path Parameters
- idstringREQUIRED
The unique identifier for the specific endpoint
- method_rate_limit_idstringREQUIRED
The unique identifier for the rate limiter
Body Parameters
- statusstring
The current status of the rate limiter; valid values include enabled or disabled
- methodsarray
An array of method names to which the rate limiter applies
- rateinteger
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, or false to apply it to the endpoint as a whole. Omit this field to keep the current setting. This can be the only field in the request.
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