List of Active Reports API
Use this API to get the list of active reports.
Input ParametersInput Parameters
|
Parameter |
Mandatory/Optional |
Data Type |
Description |
|---|---|---|---|
|
offset |
Optional |
String |
Provide offset value to paginate reports. Default value 0 |
|
limit |
Optional |
String |
Provide a number of reports to be fetched in the response. |
|
Authorization |
Mandatory |
String |
Authorization token to authenticate to the Qualys Enterprise TruRisk Platform Prepend token with Bearer and one space. For example - Bearer authToken |
Sample 1 with offset and limit parameters providedSample 1 with offset and limit parameters provided
API Request
curl -X POST
'<qualys_base_url>/etm/api/rest/v1/reports/list'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer <JWT Token>'
--data '{
"offset": 0,
"limit": 50
}'
Response
[
{
"id":"fa6cfeab-cb31-4fe8-918b-327ae6014536",
"name":"Test Report 3",
"description":"Test Report description",
"reportFormat":"JSON",
"assetQql":"asset.criticality: 5",
"findingsQql":"finding.severity: 2",
"status":"REQUESTED",
"created":"2024-11-23T21:27:03",
"createdBy":{
"id":"e254d3ed-0dbf-7207-81c9-790785f0f2a5",
"firstName":"Automation",
"lastName":"User",
"username":"john_doe"
},
"updated":"2024-11-23T21:27:03",
"updatedBy":{
"id":"e254d3ed-0dbf-7207-81c9-790785f0f2a5",
"firstName":"Automation",
"lastName":"User",
"username":"john_doe"
},
"expirationDate":"2025-12-23T21:27:02"
}
]
Sample 2 with default parametersSample 2 with default parameters
API Request
curl -X POST
'<qualys_base_url>/etm/api/rest/v1/reports/list'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer <JWT Token>'
--data '{
}'
Response
[
{
"id":"fa6cfeab-cb31-4fe8-918b-327ae6014536",
"name":"Test Report 3",
"description":"Test Report description",
"reportFormat":"JSON",
"assetQql":"asset.criticality: 5",
"findingsQql":"finding.severity: 2",
"status":"REQUESTED",
"created":"2024-11-23T21:27:03",
"createdBy":{
"id":"e254d3ed-0dbf-7207-81c9-790785f0f2a5",
"firstName":"Automation",
"lastName":"User",
"username":"john_doe"
},
"updated":"2024-11-23T21:27:03",
"updatedBy":{
"id":"e254d3ed-0dbf-7207-81c9-790785f0f2a5",
"firstName":"Automation",
"lastName":"User",
"username":"john_doe"
},
"expirationDate":"2025-12-23T21:27:02"
}
]