Release 3.0 API
October 16, 2024
Before understanding the API release highlights, learn more about the API server URL to be used in your API requests by referring to the Know Your Qualys API Server URL section. For this API Release Notes, <qualys_base_url> is mentioned in the sample API requests.
What's New?
Get a List of Generated Reports
| New or Updated API | Updated |
| API Endpoint (Deprecation timeline - April 2025) | /pm/v1/reports |
| API Endpoint (New Version) | /pm/v2/reports |
| Method | GET |
| DTD or XSD changes | Not Applicable |
With this release, we have introduced a new version of the 'Get a List of Generated Reports' API. This API limits the number of reports that can be listed. Using this API, you can get a list of a maximum of 20 reports with the latest report status.
In the case of the existing version of the /pm/v1/reports API, the default value is set to 10, and there is no limit specified on the maximum number of reports that can be listed.
Input ParametersInput Parameters
|
Parameter |
Mandatory/Optional |
Data Type |
Description |
|
limit |
Optional |
String |
Specify the number of reports to return. Default value: 20 |
Sample - Get a list of recently triggered reportsSample - Get a list of recently triggered reports
API Request
curl -X GET
"https://<QualysBaseURL>/pm/v2/reports?limit=20" -H "accept: application/json" -H "Authorization: Bearer <<jwt token>>"API Response
[
{
"reportId": "84b7e8e4-878d-4506-a8aa-fb7b278648c7",
"type": "ASSET",
"createdDate": 1719298145204,
"expirationDate": 1719902945204,
"status": 1,
"queryHavingQuery": null,
"fileSize": "8.07 KB",
"platform": "Windows",
"name": "ASSET",
"description": "Asset Report_84b7e8e4-878d-4506-a8aa-fb7b278648c7"
},
{
"reportId": "703729bf-3551-4bd0-a269-3e0728bc1cf7",
"type": "JOB_PROGRESS",
"createdDate": 1719213541633,
"expirationDate": 1719818341633,
"status": 1,
"queryHavingQuery": "(jobId:e3587d7b-6798-492d-8b20-6840a2115fbe AND jobInstanceId:1)",
"fileSize": "1.85 KB",
"platform": "Windows",
"name": "JOB_PROGRESS",
"description": "Job Progress Report_703729bf-3551-4bd0-a269-3e0728bc1cf7"
},
{
"reportId": "3a5e5951-6d09-482b-9a00-1a214005e716",
"type": "ASSET",
"createdDate": 1719206058999,
"expirationDate": 1719810858999,
"status": 1,
"queryHavingQuery": null,
"fileSize": "8.07 KB",
"platform": "Windows",
"name": "ASSET",
"description": "Asset Report_3a5e5951-6d09-482b-9a00-1a214005e716"
},
]