Fetch a List of Reports
Use this API to fetch a list of reports in your account.
Input ParametersInput Parameters
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| displayColumns | Mandatory | string | Specify the columns to include in the report. Multiple columns should be comma-separated. Valid Values: repo, uuid, sha, severity, firstDetected, qdsScore, riskScore, qid, isQidExempted, and so on. When unspecified, all report columns will be included. When an empty value is provided, only default columns will be included. |
| 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. |
| templateName | Mandatory | string | Specify the template for the report you want to create. Valid values are:
|
Sample: Fetch a List of ReportsSample: Fetch a List of Reports
API request
curl -X GET
"<qualys_base_url>/csapi/v1.3/reports?pageNumber=1&pageSize=50"
-H "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",
"repo",
"uuid",
"qid",
"firstDetected"
],
"expireOn": "2024-05-17T15:56:13.000Z",
"emailNotification": 1,
"recipient": "[email protected]",
"emailSubject": "EMAIL receive check",
"customMessage": "Test custom message",
"sendAsAttachment": 0,
"fileZipped": 0
},
{
"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",
"emailNotification": 1,
"recipient": "[email protected]",
"emailSubject": "EMAIL receive check",
"customMessage": "Test custom message",
"sendAsAttachment": 0,
"fileZipped": 0
}
],
"count": 2
}
Sample: Fetch a List of Reports using CS_KUBERNETES_PODS Sample: Fetch a List of Reports using CS_KUBERNETES_PODS
API request
curl -X 'GET' \
'<qualys_base_url>/csapi/v1.3/reports?filter=report.name%3Atest_pods_API&pageNumber=1&pageSize=50&sort=status%3Adesc' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'
Response
{
"data": [
{
"reportUuid": "4c90c260-71b5-11f0-92c4-d75b653a5a10",
"createdAt": "2025-08-05T04:33:13.000Z",
"reportName": "Test",
"description": null,
"fileFormat": "csv",
"templateName": "CS_KUBERNETES_PODS",
"status": "COMPLETED",
"isScheduled": 0,
"filter": null,
"displayColumns": [
"uuid",
"name",
"startedAt",
"namespace",
"clusterUid",
"containersSha",
"status",
"updatedAt",
"sensorUuid"
],
"expireOn": "2025-08-12T04:33:13.000Z",
"emailNotification": 0,
"recipient": "",
"emailSubject": "",
"customMessage": "",
"sendAsAttachment": 0,
"fileZipped": 0,
"expireAfter": 7
}
],
"count": 1
}
Sample: Fetch a List of Reports using CS_IMAGES Sample: Fetch a List of Reports using CS_IMAGES
API request
curl -X 'GET' \
'<qualys_base_url>/csapi/v1.3/reports?filter=report.name%3Atest_pods_API&pageNumber=1&pageSize=50&sort=status%3Adesc' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'
Response
{
"data": [
{
"reportUuid": "4c90c260-71b5-11f0-92c4-d75b653a5a10",
"createdAt": "2025-08-05T04:33:13.000Z",
"reportName": "Test",
"description": null,
"fileFormat": "csv",
"templateName": "CS_IMAGES",
"status": "COMPLETED",
"isScheduled": 0,
"filter": null,
"displayColumns": [
"uuid",
"name",
"startedAt",
"namespace",
"clusterUid",
"containersSha",
"status",
"updatedAt",
"sensorUuid"
],
"expireOn": "2025-08-12T04:33:13.000Z",
"emailNotification": 0,
"recipient": "",
"emailSubject": "",
"customMessage": "",
"sendAsAttachment": 0,
"fileZipped": 0,
"expireAfter": 7
}
],
"count": 1
}
Sample: Fetch a List of Reports using CS_CONTAINERSSample: Fetch a List of Reports using CS_CONTAINERS
API request
curl -X 'GET' \
'<qualys_base_url>/csapi/v1.3/reports?filter=report.name%3Atest_pods_API&pageNumber=1&pageSize=50&sort=status%3Adesc' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'
Response
{
"data": [
{
"reportUuid": "4c90c260-71b5-11f0-92c4-d75b653a5a10",
"createdAt": "2025-08-05T04:33:13.000Z",
"reportName": "Test",
"description": null,
"fileFormat": "csv",
"templateName": "CS_CONTAINERS",
"status": "COMPLETED",
"isScheduled": 0,
"filter": null,
"displayColumns": [
"uuid",
"name",
"startedAt",
"namespace",
"clusterUid",
"containersSha",
"status",
"updatedAt",
"sensorUuid"
],
"expireOn": "2025-08-12T04:33:13.000Z",
"emailNotification": 0,
"recipient": "",
"emailSubject": "",
"customMessage": "",
"sendAsAttachment": 0,
"fileZipped": 0,
"expireAfter": 7
}
],
"count": 1
}
Sample: Fetch a List of Reports using CS_VULNERABILITY Sample: Fetch a List of Reports using CS_VULNERABILITY
API request
curl -X 'GET' \
'<qualys_base_url>/csapi/v1.3/reports?filter=report.name%3Atest_pods_API&pageNumber=1&pageSize=50&sort=status%3Adesc' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'
Response
{
"data": [
{
"reportUuid": "4c90c260-71b5-11f0-92c4-d75b653a5a10",
"createdAt": "2025-08-05T04:33:13.000Z",
"reportName": "Test",
"description": null,
"fileFormat": "csv",
"templateName": "CS_VULNERABILITY",
"status": "COMPLETED",
"isScheduled": 0,
"filter": null,
"displayColumns": [
"uuid",
"name",
"startedAt",
"namespace",
"clusterUid",
"containersSha",
"status",
"updatedAt",
"sensorUuid"
],
"expireOn": "2025-08-12T04:33:13.000Z",
"emailNotification": 0,
"recipient": "",
"emailSubject": "",
"customMessage": "",
"sendAsAttachment": 0,
"fileZipped": 0,
"expireAfter": 7
}
],
"count": 1
}
Sample: Fetch a List of Reports using CS_IMAGE_SOFTWARE_DETAILSSample: Fetch a List of Reports using CS_IMAGE_SOFTWARE_DETAILS
API request
curl -X 'GET' \ '<qualys_base_url>/csapi/v1.3/reports?filter=report.name%3APost_API_test&pageNumber=1&pageSize=50&sort=status%3Adesc' \ -H 'accept: application/json' \ -H 'Authorization: Bearer <token>'
Response
{
"data": [
{
"reportUuid": "f64841c0-2420-11f1-a10e-63ad41ec1bb5",
"createdAt": "2026-03-20T05:52:21.000Z",
"reportName": "Post_API_test",
"description": "test",
"fileFormat": "csv",
"templateName": "CS_IMAGE_SOFTWARE_DETAILS",
"status": "COMPLETED",
"isScheduled": 0,
"filter": "{\"filter\": \"\",\"secondFilter\": \"not software.lifecycle.eol is null\"}",
"displayColumns": [
"name",
"version",
"fixVersion",
"eolDate",
"eosDate",
"imageId",
"imageSha",
"softwareName",
"softwareVersion"
],
"expireOn": "2026-03-27T05:52:21.000Z",
"emailNotification": 0,
"recipient": "",
"emailSubject": "",
"customMessage": "",
"sendAsAttachment": 0,
"fileZipped": 0,
"expireAfter": 7,
"softwareCountPerImage": 2200
}
],
"count": 1
}