Increase API call limits above default settings

This article only applies to QMetry On-Premise installations. For SaaS/Cloud customers these settings are not customizable.

QMetry Application has the below pre-defined API call limits to ensure optimum performance. However, depending upon the preferred usage of your automation teams and your server hardware capability, these limits may be modified.

Pre-defined API Call limits

API's	Maximum API Calls	Details

API's	Maximum API Calls	Details
Automation API	500 Per Day	Maximum API call limitation gets set for the entire QMetry Instance including all users. The counter would reset as per UTC time zone.
All Open API's	1000 Per Hour
All Open API's	10000 Per Day

Increasing API call limits (applicable only for QMetry v8.19.0 & above)

Caution! Increasing API call limits can lead to slowness or performance issues if the server hardware is not capable. For QMetry recommended server configurations (Large Teams) the API limits should not be set beyond 5000 hits per hour and 50000 hits per day.

Follow the below step to modify the default limits:

Execute the following command to view existing dockers running on the server.

docker ps

To go the QMetry MySQL Docker execute the command: docker exec -it <docker_name> bash
- example: docker exec -it qmetryapp_db bash

Login to QMetry DB, by replacing the username, password in the below commands

mysql -u[username] -p[password] qmetry -A

To view the currently set API limits, execute the below query

SELECT apiRequestLimit.apiRequestType, apiRequestLimit.newValue 
	FROM (
		SELECT c.*,
		ROW_NUMBER() OVER (PARTITION BY clientID, apiRequestType ORDER BY createdDate DESC) AS rn
		FROM ClientApiRequestLimit c
	) AS apiRequestLimit WHERE apiRequestLimit.rn = 1;

Turn off SQL safe updates and execute the below queries by replacing the values for the limits to be set.

set sql_safe_updates = 0; //To turn off SQL safe updates

INSERT INTO `clientapirequestlimit` (`clientID`, `apiRequestType`, `newValue`, `createdDate`)
select clientID,'automationDailyAPIRequest', '500', NOW() from client;
INSERT INTO `clientapirequestlimit` (`clientID`, `apiRequestType`, `newValue`, `createdDate`)
select clientID,'dailyAPIRequest', '10000', NOW() from client;
INSERT INTO `clientapirequestlimit` (`clientID`, `apiRequestType`, `newValue`, `createdDate`)
select clientID,'hourlyAPIRequest', '1000', NOW() from client;

set sql_safe_updates = 1; //To turn on SQL safe updates

To check the updated values run the query in Step 3 again.

exit;

Restart QMetry Tomcat Services

Check the running containers using the following command:

docker ps

Restart both docker containers using below commands:

docker stop qmetry_app_1 qmetryapp_db
docker start qmetryapp_db
docker start qmetry_app_1

In case you have any questions about these steps, send an email to qtmprofessional@qmetrysupport.atlassian.net