API-Based Throttling is used to limit the number of requests to a given API in a given time period.

When the number of messages defined by the API Based Throttling policy is reached, no new requests will be directed to the Backend API until the specified time is completed. Thus, it is prevented that the backend API is running on the server that causes more load than it can handle.

For example, if the total number of API requests is specified as 10/second (10 requests per second) and the number of messages exceeds 10 messages per second, the client will be returned with an error message stating that too many requests were made, along with the HTTP status code 403.

The image containing the policy settings is given below:


The policy fields are shown in the table below.

Field

Description

Description

An optional description of the policy that may be useful for usage and management activities.

Message Count

It is the maximum number of messages that can be sent to the Backend API within the time given by the Throttling Interval.

Throttling Interval

Indicates how long the limitation of messages that can be sent to the backend API should be applied. Its value can be "One Second" or "One Minute".

You can visit the Policies page for the details of the Conditions and Error Message Customization panels.