Selecting a Rate Limit Store

Rate Limit Stores are caches used to store data to improve API call performance. They must first be defined in Cache Connections before they become available for selection in the Settings section of the the API Publishing page. Currently, caches can be either Redis or Memcached.

Before you can enable rate limiting, a caching server needs to be connected to the project. If no caching server has been selected, an error will appear. You define the cache servers on the Cache Connections page.

Rate limiting is the number of requests that can be made to an API per window (a specific time period). For example, an API can have 1000 request per hour (window) but this is the total number of requests. This can be done to prevent an overloading of a system's infrastructure such as might be caused by a DoS (Denial of Service) attack or a DDoS (distributed denial-of-service) attack. Additionally, if requests to an API starts to become more active, the rate limit can be adjusted in steps to achieve optimum performance for users. A Rate Limit Store must be selected to use Rate Limiting.

To select a rate limit store, follow these steps.

Steps
Steps
  1. From the Home menu, select API Publishing.

  2. In the Settings section, select a defined server connection from the dropdown menu.

  3. Click Update rate limit store.

  4. The error message "Rate Limits are currently not enfored" will disappear. Rate limits are now be enabled on endpoints in the project.

Example
Example
Selecting a Rate Limit Store

‚Äč