Rate Limits

Rate limits are imposed by the SysCloud API to ensure fair usage and maintain system stability. By limiting the number of requests a client can make within a certain period, we can prevent abuse and provide a consistent experience for all users.

Rate Limit Policies

The SysCloud API enforces the following rate limit policies:

Per Endpoint Rate Limit: Each API endpoint has its own rate limit, specifying the maximum number of requests allowed within a given time period. More details regarding rate limits for each endpoint are mentioned in the API reference documentation.

The following are the endpoint level rate limits (per 60 seconds):

• Jobs: 30 requests
• Reports: 25 requests
• Entity: 25 requests

Handling Rate Limit Exceeded Errors

If you exceed the rate limit for a particular endpoint or the global rate limit, SysCloud API will return a HTTP 429 Too Many Requests status code along with a retry-after header indicating the duration after which you can retry the request. It is important to handle these errors gracefully and respect the rate limits to avoid service disruption.

Example

HTTP/1.1 429 Too Many Requests
Date: Mon, 22 Apr 2024 08:57:06 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 314
Connection: close
X-Powered-By: Express
retry-after: 58
 
{  
    "error": 
            {  
                "code": "Too Many Requests",  
                "message": "Number of incoming requests have exceeded the allocated quota, please retry after the duration specified in the retry-after header",  
                "innerError": {  
                    "code": "RateLimitExceededError",  
                    "request-id": "2ca3efbd-1b03-4648-86b5-612b8eefd029",  
                    "date": "2024-04-22T08:57:06.706Z"  
            }  
        } 
}