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": "1888e660-d238-11ed-9dcd-f52cd2719060",
"createdAt": "2023-04-03T15:56:13.000Z",
"reportName": "test1",
"description": null,
"fileFormat": "csv",
"templateName": "CS_IMAGE_VULNERABILITY",
"status": "COMPLETED",
"isScheduled": 1,
"filter": null,
"displayColumns": [
"imageId",
"qid"
],
"expireOn": "2024-05-17T15:56:13.000Z"
},
{
"reportUuid": "1884a0a0-d238-11ed-9dcd-f52cd2719060",
"createdAt": "2023-04-03T15:56:13.000Z",
"reportName": "test2",
"description": "test2",
"fileFormat": "csv",
"templateName": "CS_IMAGE_VULNERABILITY",
"status": "COMPLETED",
"isScheduled": 1,
"filter": null,
"displayColumns": [
"imageId",
"qid"
],
"expireOn": "2024-05-17T15:56:13.000Z"
}
],
"count": 5
}
Was this topic helpful?