Rate Limiting
Published 09 April 2024
The REST API endpoints are all protected by a default rate limit which is 100 requests per 60 seconds. The number of requests and time limit can be configured as per your requirements. The process of changing the default rate limits is explained below.
If the rate limit is exceeded, the API responds with a 429 Too Many Requests status code. It's best practice to include error handling for 429 responses in your code.
Changing the Rate Limit
The default rate limits are defined in the %ProgramData%\Red Gate\Redgate Monitor\appsettings.json configuration file (by default this will be C:\ProgramData\Red Gate\Redgate Monitor\appsettings.json). This file is used for configuring different aspects of the Webserver and the section which relates to rate limits is mentioned below.
"publicApiRateLimiterSettings": {
"requestsLimit": 100,
"timePeriod": 60,
"queueLimit": 5
}The requestLimit setting
This value represents the number of requests that can be made to each endpoint within a defined time.
Be mindful to consider the performance of the server when adjusting this value, as having a high value will open up the opportunity to overload the server.
The timePeriod setting
This value represents the time in which the requestLimit setting applies. The value is represented in seconds.
The queueLimit setting
This value represents the number of requests that can be queued once the limit is reached, these requests will be addressed once the specific rate limiting time has elapsed.
