Export workbench
GET {{baseUrl}}/workbenches/export?format=nessus&report=vulnerabilities&start_date=67454373&chapter=vuln_by_asset&date_range=67454373&filter.0.filter=?filter.0.filter=plugin.name&filter.0.quality=%26filter.0.quality=match&filter.0.value=%26filter.0.value=RHEL&filter.search_type=and&minimum_vuln_info=true&plugin_id=67454373&asset_id=deserunt
Exports the specified workbench to a file. Once requested, the file can be downloaded using the export download method upon receiving a ready
status from the export status method.
For more information about workbench export files, see Export File Formats.
Note: This endpoint is not intended for large or frequent exports of vulnerability or assets data. If you experience errors, reduce the volume, rate, or concurrency of your requests or narrow your filters. Contact support if you continue to experience errors. Additionally, Tenable recommends the POST /vulns/export endpoint for large or frequent exports of vulnerability data, and the POST /assets/export endpoint for large or frequent exports of assets data.
For information and best practices for retrieving vulnerability and assets data from Tenable.io, see Retrieve Vulnerability Data from Tenable.io and Retrieve Asset Data from Tenable.io.
Requires BASIC [16] user permissions. See Permissions.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
format | string | (Required) The file format to use (Nessus, HTML, PDF, or CSV). |
Note: Tag-based filters are supported for the CSV
file format type only. |
| report
| string | | (Required) The type of workbench report to be exported |
| start_date
| number | | The date (in unixtime) at which the exported results should begin to be included. Defaults to today. |
| chapter
| string | | (Required) Semicolon-separated list of chapters to include for vulnerabilities/hosts reports (vuln_by_plugin, vuln_by_asset, vuln_hosts_summary) or a single chapter for Executive Summary (exec_summary). Currently, only vuln_by_asset is supported for .nessus workbench exports. |
| date_range
| number | | The number of days of data prior to and including start_date that should be returned. If not specified, data for all dates is returned. |
| filter.0.filter
| string | | The name of the filter to apply to the exported scan report. You can find available filters by using the GET /filters/workbenches/assets endpoint. For more information about the format of this parameter, see Workbench Filters. |
| filter.0.quality
| string | | The operator of the filter to apply to the exported scan report. You can find the operators for the filter using the GET /filters/workbenches/assets endpoint. For more information about the format of this parameter, see Workbench Filters. |
| filter.0.value
| string | | The value of the filter to apply to the exported scan report. You can find valid values for the filter in the 'control' attribute of the objects returned by the GET /filters/workbenches/assets endpoint. For more information about the format of this parameter, see Workbench Filters. |
| filter.search_type
| string | | For multiple filters, specifies whether to use the AND or the OR logical operator. The default is AND. For more information about this parameter, see Workbench Filters. |
| minimum_vuln_info
| boolean | | When true
, Tenable.io returns only a minimal subset of scan details for each result, excluding plugin attributes. In this case, only plugin_output and vulnerability_state fields are always returned; first_found, last_found and last_fixed are also returned if possible. |
| plugin_id
| number | | A plugin ID. Restricts the export data to vulnerabilities that only the specified plugin detects. |
| asset_id
| string | | The UUID of an asset. Restricts the export data to findings on the specified asset only. |
RESPONSES
status: OK
{"file":"1279345678"}