Use this API to create a new report request.
Parameter |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|
name |
Mandatory |
string |
Specify a title for your report (up to 150 characters). |
description |
Optional |
string |
Specify a description for your report (up to 250 characters). |
templateName |
Mandatory |
string |
Specify the template for the report you want to create. Valid values are: CS_IMAGE_VULNERABILITY or CS_CONTAINER_VULNERABILITY |
filter |
Optional |
string |
Filter the images or containers list for the report by providing a query using Qualys syntax. Refer to the “How to Search” topic in the online help for assistance with creating your query. |
displayColumns |
Optional |
string |
Specify the columns to include in the report. Multiple columns should be comma-separated. When unspecified, ALL report columns will be included. When an empty value is provided, only default columns will be included. When the template CS_IMAGE_VULNERABILITY is used, you can include any of these columns: repo, imageId, sha, uuid, created, updated, qid, title, severity, cveids, vendorReference, cvssBase, cvssTemporal, cvss3Base, cvss3Temporal, threat, impact, solution, exploitability, associatedMalwares, category, software, result. Default columns are: qid, imageId. When the template CS_CONTAINER_VULNERABILITY is used, you can include any of these columns: name, containerId, uuid, imageId, created, hostName, hostIp, state, stateChanged, updated, qid, title, severity, cveids, vendorReference, cvssBase, cvssTemporal, cvss3Base, cvss3Temporal, threat, impact, solution, exploitability, associatedMalwares, category, software, result. Default columns are: qid, containerId. |
API request
curl -X POST
"<qualys_base_url>/csapi/v1.3/reports"
-d "{"description":"Demo Report","name":"My Container Report","templateName":"CS_CONTAINER_VULNERABILITY", "filter":"status:running","displayColumns":"["containerid","uuid","qid"]"}" --header "Authorization: Bearer <token>"
Response
response code 200
{
"reportUuId": "037570f0-0193-11ea-9327-8fbbd2104c9c"
}
Was this topic helpful?