Reset Quota

When to use

Use this policy when you want to reset quota and restart count

Details

There are situations when you want to limit the maximum number of requests for an endpoint. This may due to various reasons including the processing capacity of the backend API, assigned quota to a set of users based on their privileges, business requirements to set such limits etc.

Quota defines the maximum number of requests that will be accepted over a period of time. 

You can set the time window in units of minutes, hour, day, week or month and specify the count. The other field to set is the “Allow Count” that defines the maximum number of requests.

For example, if you set 10 in field “Interval”, “minute” in “Time Unit” and 50 in “Allow Count”, then a maximum of 50 requests will be accepted over a period of 10 minutes. If 51st request is received in the time interval, in this case in 10 minutes, it will be rejected with a response status code 429 and message “Too Many Requests”.

Configuration

The configuration fields for the policy are:

[* Indicates a mandatory field]

Name *: Display name of the policy

Description: Description of policy

Enabled: Flag to indicate if the policy is enabled. If this field is not checked, the policy will be ignored at runtime and any fields from its output will contain a default initial value

Continue on Error: Flag to indicate that the flow should continue even if this policy throws an error

Interval*: Specifies the time duration of keeping the count of requests 

Time Unit*: Unit of time. The options are minutes, hours, days, weeks, months

Allow Count*: Maximum requests that are allowed

Path: Specifies the API path (endpoint) for which this policy is to be applied

Quota Name: Specifies the name of the quota for which this policy is to be applied

Group Identifier: Identifies the group for which the quota needs to be reset

Input fields

path: Path identifies the flow which contains the quota to reset

quotaName: Name of the quota to reset

identifier: This field to identify the set of requests for which the quota will reset

Output fields

quotaUsed: The count of requests received so far

The output values are given for the group based on the inputs.