Scan Export Filters

Use filter query parameters to refine the scan export data that the POST /scans/{scan_id}/export API endpoint returns.

For more information, see:

• Filter Parameters
• Supported Filters
• Commonly-used Filters

📘

Note

Filter query parameters are not supported when exporting scan results that are older than 60 days.

Filter Parameters

For each filter you want to apply to scan export data, you must specify the following query parameters:

To specify a single filter, use '0' as the INDEX value in each filter parameter name. For example:

?filter.0.filter=plugin.id&filter.0.quality=eq&filter.0.value=1234567

To specify multiple filters:

1. Increment the INDEX portion of each filter parameter name. For example:

?filter.0.filter=host.id&filter.0.quality=eq&filter.0.value=d9217f91-f79d-4bd5-aadb-606f19cf5265&filter.1.quality=eq&filter.1.value=19970919

2. (Optional) Include the filter.search_type query parameter, for example, filter.search_type=and or filter.search_type=or. This parameter specifies whether Vulnerability Management uses the AND or the OR logical operator when matching data to the specified filters. If you omit the filter.search_type parameter, Vulnerability Management uses AND by default.

Supported Filters

For a list of supported scan filters, use the GET /filters/scans/reports endpoint.

Commonly-used Filters

The table below lists parameters for commmonly-used filters.