Your subscription’s API usage and quota information is exposed in the HTTP response headers generated by Qualys APIs (all APIs except "session" V2 API).
The HTTP status code "OK" (example: "HTTP/1.1 200 OK") is returned in the header for normal (not blocked) API calls. The HTTP status code "Conflict" (example: "HTTP/1.1 409 Conflict") is returned for API calls that were blocked.
Header |
Description |
X-RateLimit-Limit |
Maximum number of API calls allowed in any given time period of <number-seconds> seconds, where <numberseconds> is the value of X-RateLimit-Window-Sec. |
X-RateLimit-Window-Sec |
Time period (in seconds) during which up to <numberlimit> API calls are allowed, where <number-limit> is the value of X-RateLimit-Limit. |
X-RateLimit-Remaining |
Number of API calls you can make right now before reaching the rate limit <number-limit> in the last <numberseconds> seconds. |
X-RateLimit-ToWait-Sec |
The wait period (in seconds) before you can make the next API call without being blocked by the rate limiting rule. |
X-Concurrency-Limit-Limit |
Number of API calls you are allowed to run concurrently. |
X-Concurrency-Limit-Running |
Number of API calls that are running right now (including the one identified in the current HTTP response header). |
X-Powered-By |
This header is only returned when the X-Powered-By header is enabled for your subscription. It includes a unique ID generated for each subscription and a unique ID generated for each user. Click here to learn more. |