assets

Host, operating-system and generic assets.

  • Toolset name: assets

  • Enabled by default: yes

  • Tools: 13 (6 read-only)

Tools

openvas_create_asset_host

Create host asset · mutating

Create a host asset by IP address or hostname. Not idempotent.

Parameter

Type

Required

Description

comment

string

no

Optional comment

value

string

yes

IP address or hostname of the host

openvas_delete_asset

Delete generic asset · destructive

Delete a generic asset of any type (no trashcan).

Parameter

Type

Required

Description

id

string

yes

Resource UUID

openvas_delete_asset_host

Delete host asset · destructive

Delete a host asset (no trashcan).

Parameter

Type

Required

Description

id

string

yes

Resource UUID

openvas_delete_operating_system

Delete operating system · destructive

Delete an operating-system asset (no trashcan).

Parameter

Type

Required

Description

id

string

yes

Resource UUID

openvas_get_asset

Get generic asset · read-only

Get one generic asset by UUID and type.

Parameter

Type

Required

Description

id

string

yes

Asset UUID

type

string

yes

Asset type: host, os or tls_certificate

openvas_get_asset_host

Get host asset · read-only

Get one host asset by UUID.

Parameter

Type

Required

Description

id

string

yes

Resource UUID

openvas_get_operating_system

Get operating system · read-only

Get one operating-system asset by UUID, including its hosts.

Parameter

Type

Required

Description

id

string

yes

Resource UUID

openvas_list_asset_hosts

List host assets · read-only

List host assets discovered by scans, with highest severity and OS.

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)

openvas_list_assets

List generic assets · read-only

List assets of one type (host, os or tls_certificate) through the generic asset catalog.

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)

type

string

yes

Asset type: host, os or tls_certificate

openvas_list_operating_systems

List operating systems · read-only

List operating-system assets detected by scans with host counts and severities.

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)

openvas_update_asset

Update generic asset · destructive

Update a generic asset’s comment (type required for the read-back). Idempotent (PUT).

Parameter

Type

Required

Description

comment

string

no

New comment

id

string

yes

Asset UUID

type

string

yes

Asset type: host, os or tls_certificate

openvas_update_asset_host

Update host asset · destructive

Update a host asset’s comment. Idempotent (PUT).

Parameter

Type

Required

Description

comment

string

no

New comment

id

string

yes

Resource UUID

openvas_update_operating_system

Update operating system · destructive

Update an operating-system asset’s comment. Idempotent (PUT).

Parameter

Type

Required

Description

comment

string

no

New comment

id

string

yes

Resource UUID