Create report

post

https://cloud.tenable.com/reports/export

Creates a report in PDF format based on the specified template and filters.

Note: Tenable Vulnerability Management limits the number of findings that can be included in a single report to 10,000. If you have more than 10,000 findings, Tenable recommends that you narrow the findings included in the report with a filter or generate multiple reports. Additionally, you can not run more than 50 concurrent reports at a time.

Requires the Basic [16] user role or the VM.VM_REPORT.VM_REPORT.GENERATE custom role privilege. See Roles.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

A name for the report.

If this parameter is omitted, Tenable Vulnerability Management uses the default name Vulnerabilities_Export_Report with a timestamp in ISO 8601 format appended to the end to create a unique name. For example, Vulnerabilities_Export_Report_2023-11-30T00:23:13.199227748Z.

template_name

string

enum

required

The type of template to use for the report. The following templates are available:

host_vulns_summary—An executive summary report that provides operations teams a snapshot of risk based on vulnerable assets.
host_vulns_by_plugins—A report that provides a summary of the plugins that detected vulnerabilities on affected assets. Plugins are sorted by severity and the assets are sorted by the Asset Criticality Rating (ACR).
host_vulns_by_assets—A summary of the most vulnerable assets.

Allowed:

filters

array of objects

A set of filters to apply to the report. Filters can be used to narrow the vulnerabilities or assets included in the report.

You can use the GET /filters/reports/export endpoint to retrieve the list of valid filters, their supported comparison operators, data types, and allowed values. For more information, see Report Export Filters.

filters

Responses

403

Returned if you do not have permission to create reports.

200Returned if Tenable Vulnerability Management successfully queued the report export request.

400Returned if your request specified invalid parameters or if your request was improperly formatted.

500Returned if Tenable Vulnerability Management encountered an error while attempting to queue the report export request.