Spike Control

When to use

Use this policy when you want to protect against sudden spike of traffic

Details

Sudden traffic surges could for any reason including an ill behaviour of the requesting application due to looping or DDoS attacks.

Rate in this policy defines the maximum number of requests that will be accepted over a period of time. 

You can set the time window in units of seconds or minutes.

For example, if you set 1000 in field “Rate”, “minute” in “Time Unit”, then a maximum of 1000 requests will be accepted over a period of 1 minute. Any further requests during that period will be rejected with a response status code 429 and message “Too Many Requests”.

Configuration

[* Indicates a mandatory field]

The configuration fields for the policy are:

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

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

Rate*: Maximum requests that are allowed

Request Weightage: Specifies the number by which the counter will increase. This is used when you want to count requests based on any parameter of request for example method type or a parameter value. By default the value is 1

Start Date: Specifies the date when the policy should start The date format is dd/mm/yyyy

Start Time: Specifies the time when the policy should start. Time format is HH:mm:ss

Input fields

There are no input fields for this policy

Output fields

result: If the request is accepted, then the return value is true, otherwise it’s false.