Use this API to fetch a list of reports from your account.
Parameter |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|
filter |
Optional |
string |
Filter the reports list by providing a query using Qualys syntax. Currently, you can only filter by reportName. Refer to the “How to Search” topic in the online help for assistance with creating your query. |
pageSize |
Optional |
integer |
The number of records per page to be included in the response. The default value is 50. |
pageNumber |
Optional |
integer |
The page to be returned. Page numbers start with 1. The default value is 1. |
sort |
Optional |
string |
Sort the results using a Qualys token. You can sort by status or reportName only. Default value is status:desc. Refer to the “Sortable tokens” topic in the online help for more information. |
API request
curl -X GET
"<qualys_base_url>/csapi/v1.3/reports?pageNumber=1&pageSize=50" --header "Authorization: Bearer <token>"
Response
{
"data": [
{
"reportUuid": "4738d060-5b02-11eb-a819-9b3f1886eb36",
"createdAt": "2021-01-20T09:31:27.000Z",
"reportName": "sample-image-report",
"description": null,
"fileFormat": "csv",
"templateName": "CS_IMAGE_VULNERABILITY",
"status": "FAILED",
"reportType": "ON_DEMAND",
"filter": null,
"displayColumns": [
"ALL"
]
},
{
"reportUuid": "42699db0-9eb1-11eb-bbb6-833197dc0c5b",
"createdAt": "2021-04-16T12:42:52.000Z",
"reportName": "sample-container-report",
"description": null,
"fileFormat": "csv",
"templateName": "CS_CONTAINER_VULNERABILITY",
"status": "COMPLETED",
"reportType": "ON_DEMAND",
"filter": "",
"displayColumns": [
"name",
"containerId",
"imageId",
"qid",
"cveids"
]
}
],
"count": 2
}
Was this topic helpful?