Rate limiting
The SC//Reliant™ platform throttles all API requests on a per-customer basis. All API calls are subject to the rate limits regardless of where they originate from, such as from the SC//Reliant Platform Manager, a command line tool, or an application.
When making an API call, if you request that the x-rate-limit header is included in the response then the response will identify the rate limit for your account.
| Header name | Description |
|---|---|
x-rate-limit | The number of API requests that can be made. The rate limit measurement will be displayed as either per minute, per hour, or per day depending on the rate limit set on your account. |
If your account doesn't have a specific API rate limit set, then the x-rate-limit header isn't sent in the response.
The following shows an example request where the rate limit is 667 requests per minute.
> Doing a request to 'https://platform.reliant.io/api/locations'
< response code: 200
< x-rate-limit: 667 requests per minute
< x-current-rate: 0 request per minuteExceeding the API rate limit
When the rate limit has been reached, you will receive a 429 response back with the following retry-after header.
| Header name | Description |
|---|---|
Retry-After | The amount of time, in seconds, in which you must wait until you can make a successful request. |
The following is an example response when the rate limit is reached.
> Doing a request to 'https://platform.reliant.io/api/locations'
< response code: 429
< retry-after: 1906.78