Help Menu

What are the API rate limits?

The number of requests to a specific API endpoint is throttled to a total number of 6,000 requests per minute per user account.

For collection endpoints (POST resource and GET resources), the endpoint is defined as the API URL and the HTTP method, for example:

• GET https://www.alertersystem.com/api/partition
• POST https://www.alertersystem.com/api/partition

For item endpoints (PUT resource, DELETE resource and GET resource), the endpoint is defined as the API URL including the resource ID and the HTTP method, for example:

• GET https://www.alertersystem.com/api/partition/1ed26517-dae5-686a-908f-efc59422732b
• PUT https://www.alertersystem.com/api/partition/1ed26517-dae5-686a-908f-efc59422732b
• DELETE https://www.alertersystem.com/api/partition/1ed26517-dae5-686a-908f-efc59422732b

Every HTTP response from the API includes a set of rate limit headers, which are as follows:

• X-RateLimit-Limit: The total allowed number of requests per rate limit period.
• X-RateLimit-Remaining: The number of requests remaining in the rate limit period.
• X-RateLimit-Reset: The epoch time (seconds since 00:00:00 UTC on January 1, 1970) at which the rate limit resets.
• X-RateLimit-Reset-8061: The date and time at which the rate limit resets in ISO 8601 format.

What happens when an API request is rate limited?

The API will refuse to process the request and will respond with a 429 HTTP response code.

What should I do when a request is rate limited?

Your app must immediately cease making API requests to that specific endpoint until the X-RateLimit-Reset time has expired and the rate limit has been reset.

Do my team members all share the same rate limits?

No, rate limits are per user account. Each team member is logged in to their own user account, even when they are working on your resources. Their API rate limits are not aggregated into the rate limits on your user account.

What do I do if I need higher rate limits?

Please contact our support staff and discuss your need and use case with them.