Define a throttling counter

In the API throttling panel of API Keys and Traffic Management, you can set up throttling counters for specific sets of input conditions that incoming requests will match. In other words, you set up match criteria that determine whether a specific request increments the counter and applies toward the moving average threshold set for that counter.

Try the API: You can also complete this task by using the Key and Quota Management API. Run the Create a throttling counter operation. Learn more about Akamai’s APIs.

How to

  1. In API Keys and Traffic Management, select the API throttling tab.
  2. Click the plus sign to create a throttling counter.
  3. Set the Enable this counter switch to Yes.
  4. In the Counter name field, enter a meaningful name for the counter.
    For example, if you are creating a counter that limits requests to a particular registered API, you can use the name of this API to name the counter.
  5. From the Access control group list, select the access control group that you want to associate with the counter.
  6. In the Requests per second field, enter the allowed number of requests per second.
    This value indicates the maximum allowed number of requests matching the associated throttling conditions per second. If the request count reaches the defined limit, API Gateway rejects any excessive requests with a 429 response until the moving average for this throttling counter diminishes to the set threshold. This usually takes up to ten seconds.
  7. In the When limit is reached field, select the preferred API Gateway behavior when the throttling counter reaches its requests-per-second limit.
    Select Warn to allow the requests above 80% of the throttling limit for this counter to still reach your origin and configure throttling headers to provide information about the limit. Select Deny to reject the requests that exceed the throttling limit for this counter.
  8. Do one of these steps:
    If...Then...
    If you selected Warn, then do these steps:
    1. Click Add Alert to create an alert configuration
    2. In Alert name, enter a meaningful name for the alert.
    3. In Emails, enter the internal email addresses to send the alert to.

      Internal email addresses end with akamai.com.

    Tip: You can click the ellipsis icon and select the View in alerting app option to view your alert configuration and history of its occurrence in the Alerts application in Control Center.

    For more information on the API Gateway throttling limit alert, see Alerts.

    If you selected Deny, then move on to the next step.
  9. In the Counter notes field, enter meaningful notes about the counter for future reference.
  10. In the Throttling headers section, select the response headers to return to the origin or API client.
    Throttling limit response headers
    Header Description
    X-Throttling-Limit The requests-per-second limit set for a throttling counter.
    X-Throttling-Rate The remaining requests available in the current second.