Usage and Rate Limits

Rate limit refers to the number of API calls one can make in a HPE Aruba Networking Central account per day.

Dynamic Rate Limit Calculation

All accounts start with a base API rate limit of 5,000 API calls per day, even if there are no devices in the account.

The rate limit remains fixed at 5000 API calls per day until the calculated dynamic rate limit exceeds 5000 API calls/day. This dynamic rate is based on the number of subscribed devices & the type of subscription assigned to each device in the account.

The dynamic rate limit is calculated as follows:

The base rate of 5000 API calls/day covers upto 166 Foundation devices(since 166 devices x 30 API calls = 4980 API calls/day). Once the calculated limit exceeds 5000, the rate limit dynamically increases.

This approach ensures that:

1. Smaller deployments are covered by the base rate limit.
2. Larger accounts automatically get a higher rate limit based on their device count & subscription type.

👍

Example Calculation

Scenario: A Central account has a 200 devices - 100 devices with Foundation subscription, and 100 devices with Advanced subscription.

The dynamic per-day rate limit can be calculated as follows:

• Devices with Foundation Subscription: 100 devices x 30 API calls = 3000 API calls/day
• Devices with Advanced Subscription: 100 devices x 90 API calls = 9000 API calls/day

Total Rate limit = 3000 + 9000 = 12000 API calls/day

Viewing Rate Limits in the UI

Admin users can view the per-day API rate limit in the Usage Tab of the API Gateway section of the Central UI.

The Usage Tab is only available to users with admin role & provides detailed API usage statistics for the last 7 days, including -

• Top API endpoints by usage
• Per-user API usage
• Overall API Usage

These insights help administrators monitor & optimize API usage across the account

📘

Note

Rate Limit resets at GMT midnight.

Rate limit Details in API Responses

The table below illustrates important values relevant to the usage and rate limits of the API calls. These values can be found in the HTTP Response Headers for all REST API calls.

This is an example of HTTP Response Headers for an API call where you can find usage and rate limit values.

{
  "access-control-allow-origin": "*",
  "cache-control": "no-cache, no-store, must-revalidate, private",
  "connection": "keep-alive",
  "content-encoding": "gzip",
  "content-type": "application/json",
  "date": "Fri, 21 Jan 2022 18:50:27 GMT",
  "pragma": "no-cache",
  "transfer-encoding": "chunked",
  "vary": "Accept-Encoding",
  "via": "kong/0.14.1",
  "x-frame-options": "SAMEORIGIN",
  "x-kong-proxy-latency": "3",
  "x-kong-upstream-latency": "146",
  "x-ratelimit-limit-day": "1000",
  "x-ratelimit-limit-second": "7",
  "x-ratelimit-remaining-day": "998",
  "x-ratelimit-remaining-second": "6",
  "x-request-start": "t=1642791027.187",
  "x-xss-protection": "1; mode=block"
}