Instaclustr API Rate Limits
Overview
NetApp Instaclustr throttles API requests to maintain service stability, this applies to most of our API. The rate limit is imposed on each individual account, and may differ for API endpoints, depending on intended usage of the API endpoint.
From February 2025, NetApp Instaclustr will be rolling out a new dynamic rate limiting system, to better reflect the intended usage of each API endpoint. This will provide a more stable API service for everyone, and allow us to appropriately scale the capacity of the API service in line with the scale of our customer’s infrastructure.
What’s Changing?
The new rate-limiting system enhances service equity and efficiency for all customers. Previously static limits did not consider the number of clusters in your account.
With the new rate limiting system, API request limits for the Instaclustr Managed Platform will dynamically adjust based on the number of clusters and nodes in your account. As you scale, your rate limits will increase proportionately, ensuring efficient handling of your requests.
| Important: The rate limits are applied at the account level. If there are multiple users accessing the API under the same account, it’s crucial to coordinate usage to make sure that 1 user doesn’t use up the entire quota, which could potentially impact others. |
How Request Rate Limiting Is Applied
Instaclustr API uses sliding window algorithm to rate limit requests. Your current API usage is the number of accepted requests in the last x seconds where x is the size of sliding window.
If request exceeds an API throttling limit, the response returned has code 429 with message Rate Limit Exceeded.
| Our monitoring metrics are updated every 20 seconds, so requesting the same metric more than once within that timeframe will always return the same response. |
When Are the Changes Coming?
Starting February 10, 2025, rate limits will be applied to Prometheus Metrics v2 endpoints as the first phase of this rollout. By March 31 2025, rate limits will be extended to additional endpoints, including Monitoring and Cluster Management APIs.
Understanding Rate Limits
- Fixed limit: Number of requests allowed for an endpoint within a specified time interval, regardless of the number of clusters or nodes in your account.
- Interval: Defines the time window during which the rate limit applies.
- Dynamic Rate Limit: The rate limit scales with the number of clusters in your Instaclustr account, using a rate multiplier – a predefined value for each API endpoint that determines the request rate increase per cluster.
Note: Where an endpoint has both Dynamic and Fixed limits the larger limit will apply.
Detailed information about rate limits for each endpoint is provided below:
Phase 1:
Date of roll out: February 10, 2025
Metrics v2 Prometheus Monitoring Endpoints
| Endpoint Path | Fixed Limit (requests) | Interval (seconds) | New – Dynamic Rate Limit | Comment |
|---|---|---|---|---|
| https://<node or cluster id>.api.instaclustr.com/metrics/v2/query | 2 | 20 | N/A | Prometheus: retrieves a node or cluster level metrics. Rate limit applies per node/cluster id |
Phase 2:
Date of roll out: March 31, 2025
Following the initial roll-out for Prometheus Metrics v2 endpoints, we will apply rate limits to the following endpoints:
Cluster Management API Endpoints
| Endpoint Path | Fixed Limit (requests) | Interval (seconds) | New – Dynamic Rate Limit | Comment |
|---|---|---|---|---|
| https://api.instaclustr.com/cluster-management/v2/* | 1 | 1 | 0.1 x clusters | Provisioning actions such as create cluster and read cluster details. |
Examples
Scenario 1: Three clusters in 1 of your accounts
- Fixed limit: 1 request/second
- Dynamic limit 0.1 x clusters = 0.1 x 3 = 0.3 requests/second
- Even though 3 clusters would calculate to 0.3 requests/second under the formula, the fixed rate of 1 request/second is applied.
Scenario 2: 30 clusters in 1 of your accounts.
- Fixed limit: 1 request/second
- Dynamic limit: 0.1 x clusters = 0.1 x 30 = 3 requests/second
- At 30 clusters, the limit increases from the fixed 1 request/second to 3 requests/second, providing greater API access to handle increasing workloads.
Monitoring API Endpoints
Monitoring metrics are refreshed every 20 seconds, and requests made before the next refresh will return the same response as the previous time the metrics were refreshed.
| Endpoint Path | Fixed Limit (requests) | Interval (seconds) | New – Dynamic Rate Limit | Comment |
|---|---|---|---|---|
| https://api.instaclustr.com/monitoring/v1 | 10 | 20 | 10 x clusters | Retrieve specified metrics from cluster/CDC/node |
| https://<cluster id>.api.instaclustr.com/discovery/v1/* | 2 | 20 | 2 x clusters | Prometheus: discover clusters’ metrics endpoints |
Deprecated Provisioning Endpoints
New workloads should not use the Provisioning API, and existing workloads should begin migrating to the Cluster Management API. A more detailed announcement will be released shortly, including a timeline for removing the Provisioning API. You can see all the deprecated and current API endpoints here.
| Endpoint Path | Fixed Limit (requests) | Interval (seconds) | New – Dynamic Rate Limit | Comment |
|---|---|---|---|---|
| https://api.instaclustr.com/provisioning/v1 | 1 | 2 | N/A | Get all clusters in account |
| https://api.instaclustr.com/provisioning/v1/* | 2 | 20 | 2 x clusters | Get specific clusters detail |
Exemptions
Console
- All requests are exempted from rate limit restriction to ensure a smooth user experience on the Instaclustr Console.
- Instaclustr Terraform Provider: Additional bursts available to facilitate large infrastructure changes. If you still experience rate limits, wait 5 minutes before retrying. If rate limiting persists, please contact support.
What’s Next?
To ensure a smooth transition to the new rate-limiting system:
- We will soon contact the accounts that may be impacted by these changes to provide guidance and support for adjustments to API requests.
- As a best practice, consider consolidating repetitive requests and adjusting the frequency of requests for data that doesn’t change often to remain within the limits.
Need to make more requests?
If you have specific use-case requiring higher rate limit than specified above, please contact [email protected] so that we can review and discuss your use case to determine the best course of action.
Other Useful Resources
- Visit our API documentation to learn more about the available API endpoints.
- Visit our website to learn more about our Cluster Management API.
- Learn more about how our Monitoring API works.
- Details on how to configure Prometheus Integration with Instaclustr Monitoring API.
- Learn how to use Instaclustr Monitoring API with DataDog.
By Instaclustr Support