Description: Get a list of reports that were generated.
Since: 3.73.x
Security: Requires a user with the Manage Reports role.
Usage: POST /api/v1/reports/cveSearchList
Sample Request
Pagination Query Parameters
Parameter | Description |
---|---|
direction | desc/asc |
page_num | Number of pages to present |
num_of_rows | Number of rows per page |
order_by | Order of presentation |
Required Parameters
Parameter | Type | Mandatory/Optional | Description |
---|---|---|---|
filters | object <filters> | optional | The filters for results |
filters
Parameter | Type | Mandatory/Optional | Description |
---|---|---|---|
name | string | optional | Wildcard patterns for including report names |
start_time_range.start | string | optional | The start of this date range. This is a timestamp in RFC 3339 format: <YYYY-MM-DDTHH-MM-SSZ> |
start_time_range.end | string | optional | The end of this date range. This is a timestamp in RFC 3339 format: <YYYY-MM-DDTHH-MM-SSZ> |
author | string | optional | Author of the report |
status | array <string> | optional | List of report statuses to include in result |
Response Codes
Status Code | Description |
---|---|
200 | OK |
400 | Bad request |
500 | Server error |
{ "filters": { "name": "*cve-2020*", "start_time_range": { "start": "2023-01-05T08:00:00Z", "end": "2023-01-22T20:00:00Z" }, "status": ["completed","running"], "author": "admin" } }
Sample Response
{ "total_reports": 1, "reports": [ { "id": 1, "cve": "CVE-2014-3526", "name": "big-report", "status": "completed", "total_artifacts": 244, "num_of_processed_artifacts": 244, "progress": 100, "number_of_rows": 1220000, "start_time": "2023-06-25T10:35:24Z", "end_time": "2023-06-25T10:36:23Z", "author": "admin" } ] }