reports

Scan reports, drill-down pages, imports and exports.

• Toolset name: reports

• Enabled by default: yes

• Tools: 18 (15 read-only)

Tools

openvas_cancel_job

Cancel job · destructive

Cancel an asynchronous job you created.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_delete_report

Delete report · destructive

Permanently delete a scan report (reports have no trashcan). The task itself is not affected.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_download_job_result

Download job result · read-only

Download the artifact of a succeeded export job. JSON exports are returned inline; binary formats (PDF, XML, CSV…) are returned as base64. Both are capped at 3 MB — for larger artifacts, export with a narrower filter or page through the results instead.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_export_report

Export report · read-only

Start an asynchronous report export. Returns a job (usually queued); poll it with openvas_get_job, then fetch the artifact with openvas_download_job_result once the status is succeeded. Jobs and artifacts expire ~15 minutes after completion; keep polling at least every few minutes, since an idle job session is closed by the gateway.

Parameter	Type	Required	Description
filter	string	no	Optional GMP filter expression applied during generation
filter_id	string	no	Optional saved filter UUID applied during generation
id	string	yes	Report UUID
report_config_id	string	no	Optional report configuration UUID (gvmd report formats only)
report_format_id	string	no	UUID of a gvmd report format (see openvas_list_report_formats). Omit to request the gateway’s native JSON export.

openvas_get_job

Get job status · read-only

Get the status of an asynchronous job (queued, running, succeeded, failed, cancelling, cancelled or expired).

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_get_report

Get report · read-only

Get one scan report by UUID: task, timing, severity, result counts and one page of embedded results (page/per_page).

Parameter	Type	Required	Description
id	string	yes	Report UUID
page	integer	no	Page of embedded results to include (1-indexed) (min 0)
per_page	integer	no	Embedded results per page (1-1000) (min 0)

openvas_get_report_applications

Report applications · read-only

List the applications (CPEs) detected in one report.

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
id	string	yes	Report UUID
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)

openvas_get_report_closed_cves

Report closed CVEs · read-only

List CVEs that are closed (no longer detected) according to one report.

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
id	string	yes	Report UUID
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)

openvas_get_report_cves

Report CVEs · read-only

List the CVEs referenced by the findings of one report.

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
id	string	yes	Report UUID
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)

openvas_get_report_errors

Report errors · read-only

List scan errors recorded in one report (NVTs that failed to run).

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
id	string	yes	Report UUID
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)

openvas_get_report_hosts

Report hosts · read-only

List the hosts covered by one report with their severity.

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
id	string	yes	Report UUID
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)

openvas_get_report_operating_systems

Report operating systems · read-only

List the operating systems detected in one report.

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
id	string	yes	Report UUID
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)

openvas_get_report_ports

Report ports · read-only

List the ports found open in one report with their severity.

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
id	string	yes	Report UUID
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)

openvas_get_report_results

Report results · read-only

List the individual results (findings) inside one report. Supports GMP filter expressions like severity>7.

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
id	string	yes	Report UUID
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)

openvas_get_report_tls_certificates

Report TLS certificates · read-only

List TLS certificates discovered during the scan behind one report.

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
id	string	yes	Report UUID
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)

openvas_get_report_vulnerabilities

Report vulnerabilities · read-only

List the vulnerabilities page of one report (aggregated findings per NVT).

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
id	string	yes	Report UUID
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)

openvas_import_report

Import report · mutating

Import a GMP XML report into an existing import task. Returns the new report’s UUID.

Parameter	Type	Required	Description
in_assets	boolean	no	Whether hosts from the report are added to assets (omit for the backend default)
report_xml	string	yes	One complete GMP XML report envelope (<report>…</report>), at most 10 MiB
task_id	string	yes	UUID of an existing import task (create one with openvas_create_task and type: "import")

openvas_list_reports

List reports · read-only

List scan reports with severity and result counts.

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)