REST API Rate Limits
- Mickey Bushman
- Jason Andrew
Owned by Mickey Bushman
Overall Limit
Unless otherwise specified in the Specific Limits section below, each individual ServiceMobility API endpoint is limited to being requested a maximum of 15 times per second.
Specific Limits
All of the following ServiceMobility API endpoints are limited to being requested a maximum of 1 time per 30 seconds.
- All Products REST API endpoints, other than where the GET operation is used.
- All Service Code REST API endpoints, other than where the GET operation is used.
- All User REST API endpoints, other than where the GET operation is used.
- All Work Order Alert REST API endpoints, other than where the GET operation is used.
Rate Limit Headers
ServiceMobility REST API responses include the following headers relating to rate limits:
- X-RateLimit-Limit: The number of requests the API permits in a given time interval.
- X-RateLimit-Remaining: The number of remaining times the API may be successfully called in the current time interval.
- X-RateLimit-Reset: How many seconds until the current time interval will end, and the number of requests will reset to the maximum permitted number.
Over-Limit Behaviour
When an API request is made that has exceeded rate limits, ServiceMobility will return an HTTP 429 status code, and the following header will be included in the response:
- Retry-After: How many second the client should wait before attempting to retry the API request which was rejected.