scan-configs

Scan configurations, NVT/family selection, preferences and generic configs.

• Toolset name: scan-configs

• Enabled by default: yes

• Tools: 16 (8 read-only)

Tools

openvas_clone_config

Clone generic config · mutating

Clone a generic config of any usage type. Returns the UUID of the copy.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_create_scan_config

Create scan config · mutating

Create a scan configuration as a copy of an existing one (gvmd always copies; pick a base such as “Full and fast” or “Base”). Not idempotent: repeating the call creates duplicates.

Parameter	Type	Required	Description
base_scan_config_id	string	yes	UUID of the active scan config to copy from (required by gvmd)
comment	string	no	Optional comment
name	string	yes	Scan config name

openvas_delete_config

Delete generic config · destructive

Delete a generic config of any usage type (to the trashcan by default; ultimate deletes permanently).

Parameter	Type	Required	Description
id	string	yes	Resource UUID
ultimate	boolean	no	Permanently delete instead of moving to the trashcan (default false)

openvas_delete_scan_config

Delete scan config · destructive

Delete a scan configuration (to the trashcan by default; ultimate deletes permanently). Fails with 409 if a task still uses it.

Parameter	Type	Required	Description
id	string	yes	Resource UUID
ultimate	boolean	no	Permanently delete instead of moving to the trashcan (default false)

openvas_get_config

Get generic config · read-only

Get one generic config by UUID (any usage type).

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_get_scan_config

Get scan config · read-only

Get one scan configuration by UUID.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_get_scan_config_nvt

Get scan config NVT · read-only

Get one NVT as selected by a scan configuration (404 if the config does not select it).

Parameter	Type	Required	Description
id	string	yes	Scan config UUID
oid	string	yes	NVT OID

openvas_get_scan_config_preference

Get scan config preference · read-only

Get one configured preference of a scan configuration by name (scoped to an NVT with nvt_oid).

Parameter	Type	Required	Description
id	string	yes	Scan config UUID
name	string	yes	Preference name
nvt_oid	string	no	NVT OID when the preference belongs to an NVT

openvas_list_configs

List generic configs · read-only

List configs across usage types (scan, audit, policy) in one catalog; filter with usage_type.

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)
usage_type	string	no	Restrict to one usage type: scan, audit or policy

openvas_list_scan_config_nvts

List scan config NVTs · read-only

List the NVTs selected by a scan configuration, optionally restricted to one family. Pagination only (no filter expressions).

Parameter	Type	Required	Description
family	string	no	Restrict to one NVT family
id	string	yes	Scan config 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_list_scan_config_preferences

List scan config preferences · read-only

List the configured preferences of a scan configuration (scanner preferences, or one NVT’s preferences when nvt_oid is given).

Parameter	Type	Required	Description
id	string	yes	Scan config UUID
nvt_oid	string	no	Restrict to one NVT’s preferences

openvas_list_scan_configs

List scan configs · read-only

List scan configurations (e.g. “Full and fast”). Returns summarized rows plus pagination; use openvas_get_scan_config for full details.

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_set_scan_config_family_selection

Set scan config family selection · destructive

Replace the family selection of a scan configuration: which NVT families are enabled, whether each grows with the feed, and whether all of its NVTs are selected. Idempotent (PUT).

Parameter	Type	Required	Description
auto_add_new_families	boolean	no	Automatically add families that appear in future feed updates
families	array	yes	Complete replacement family selection Each item: all (boolean, required): Select every NVT of the family; growing (boolean, required): Automatically include NVTs added to this family by feed updates; name (string, required): Family name, e.g. “Web Servers”.
id	string	yes	Scan config UUID

openvas_set_scan_config_nvt_selection

Set scan config NVT selection · destructive

Replace the NVT selection of one family in a scan configuration with exactly the given OIDs. Idempotent (PUT).

Parameter	Type	Required	Description
family	string	yes	Family whose selection is replaced
id	string	yes	Scan config UUID
nvt_oids	array	yes	Complete replacement list of NVT OIDs for the family

openvas_set_scan_config_preference

Set scan config preference · destructive

Set (or, with value omitted, reset to default) one preference of a scan configuration. Scope to an NVT with nvt_oid for NVT preferences. Idempotent (PUT).

Parameter	Type	Required	Description
id	string	yes	Scan config UUID
name	string	yes	Preference name
nvt_oid	string	no	NVT OID when the preference belongs to an NVT
value	string	no	New value; omit to reset the preference to its default

openvas_update_scan_config

Update scan config · destructive

Rename or re-comment a scan configuration. Idempotent (PUT); fails with 409 if the config is predefined or in use.

Parameter	Type	Required	Description
comment	string	no
id	string	yes	UUID of the scan config to update
name	string	no