Skip to content

[ILX-58820] Updated API RateLimit Description #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Arpit-Ribadiya wants to merge 2 commits into
base: master
Choose a base branch
from
+8 −6
Open

[ILX-58820] Updated API RateLimit Description #47

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b1a77c6
[ILX-58820] Updated API RateLimit Description
Arpit-Ribadiya Jan 12, 2026
84fbb70
[ILX-58820] Addressed Feedback
Arpit-Ribadiya Jan 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions source/includes/_api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,17 +139,19 @@ Response Code | Meaning
When we make backwards-incompatible changes to the API, we release new versions. The current version is **v2** and can be determined with our API base path **/api/v2/**. Read our [Intelex platform release notes](https://community.intelex.com/library/knowledgebase/release-notes) to see our API changelog.

## API Rate Limiting / Quotas
To ensure Intelex Platform is reliable and has the expected performance for all users, we limit the number of API calls an API user (or application) can make within a given time period. If the limit is exceeded, the API user may be throttled and subsequent requests within the same period will fail (status code 429).
To ensure Intelex Platform is reliable and has the expected performance for all users, we limit the number of API calls an API user (or application) can make within a given time period. If the limit is exceeded, the API user may be throttled and subsequent requests will be rejected, returning HTTP response code 429 Too Many Requests. In such cases it is the responsibility of the client application to implement appropriate retry logic for requests that are rejected due to rate limiting.

### Limit
The Intelex Platform API Rate limit is **2 requests per second**.
The Intelex Platform API Rate limit is **6 requests per second**.

### Quota headers
Quota details may be passed back to the API user/application via response headers.

Header | Description | Sample value
---------- | ------- | -------
X-RateLimit-Limit | The request limit per specified unit of time. | 100
X-RateLimit-Remaining | The remaining number of requests that API consumers can send in the current time window. | 75
X-RateLimit-Reset | The UTC epoch timestamp indicating the time of the next quota reset. Sent only when quota remains. | 1521214822
X-RateLimit-Next | The UTC epoch timestamp indicating the time of the next quota reset. Sent only when quota is full. |1521215291
Retry-After | Time in seconds to wait before retrying the request after rate limit is exceeded. | 600

### Best Practices

* Use HTTP clients that support automatic retries with an exponential back-off strategy when receiving 429 (Too Many Requests) responses.
* Avoid spikes of traffic by spreading out API calls over time wherever possible.
Loading