targets

Scan targets (hosts, port lists), OCI image and web application targets.

• Toolset name: targets

• Enabled by default: yes

• Tools: 18 (6 read-only)

Tools

openvas_clone_oci_image_target

Clone OCI image target · mutating

Clone an OCI image target. Returns the UUID of the copy.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_clone_target

Clone target · mutating

Clone a scan target. Returns the UUID of the copy.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_clone_web_application_target

Clone web application target · mutating

Clone a web application target. Returns the UUID of the copy.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_create_oci_image_target

Create OCI image target · mutating

Create an OCI image target from one or more image references (e.g. registry.example/app:1.2). Not idempotent.

Parameter	Type	Required	Description
comment	string	no	Optional comment
credential_id	string	no	UUID of a registry credential
image_references	array	yes	Image references, e.g. “registry.example/app:1.2” (at least one)
name	string	yes	Target name

openvas_create_target

Create target · mutating

Create a scan target from host entries. Not idempotent: repeating the call creates duplicates (the gateway rejects duplicate names with 400).

Parameter	Type	Required	Description
alive_test	string	no	Alive test method. One of: “Scan Config Default”, “ICMP Ping”, “TCP-ACK Service Ping”, “TCP-SYN Service Ping”, “ARP Ping”, “ICMP, TCP-ACK Service Ping”, “ICMP, ARP Ping”, “TCP-ACK Service, ARP Ping”, “ICMP, TCP-ACK Service, ARP Ping”, “Consider Alive”
comment	string	no	Optional comment
esxi_credential_id	string	no	ESXi credential UUID for authenticated scans
exclude_hosts	array	no	Hosts to exclude from scans
hosts	array	yes	Host entries: IPs, CIDR ranges, hostnames
name	string	yes	Target name
port_list_id	string	no	UUID of the port list to scan (gvmd requires one before a task can run; see openvas_list_port_lists)
reverse_lookup_only	boolean	no	Only scan hosts that resolve via reverse lookup
reverse_lookup_unify	boolean	no	Deduplicate hosts that reverse-resolve to the same name
smb_credential_id	string	no	SMB credential UUID for authenticated scans
snmp_credential_id	string	no	SNMP credential UUID for authenticated scans
ssh_credential_id	string	no	SSH credential UUID for authenticated scans

openvas_create_web_application_target

Create web application target · mutating

Create a web application target from one or more URLs. Not idempotent.

Parameter	Type	Required	Description
comment	string	no	Optional comment
credential_id	string	no	UUID of a credential for authenticated crawling
exclude_urls	array	no	URLs excluded from crawling
name	string	yes	Target name
urls	array	yes	Start URLs, e.g. “https://shop.example” (at least one)

openvas_delete_oci_image_target

Delete OCI image target · destructive

Delete an OCI image target (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_target

Delete target · destructive

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

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

openvas_delete_web_application_target

Delete web application target · destructive

Delete a web application target (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_get_oci_image_target

Get OCI image target · read-only

Get one OCI image target by UUID.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_get_target

Get target · read-only

Get one scan target by UUID, including credentials, alive test and port list bindings.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_get_web_application_target

Get web application target · read-only

Get one web application target by UUID.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_list_oci_image_targets

List OCI image targets · read-only

List OCI (container) image targets. trash lists trashed ones.

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)
trash	boolean	no	List trashed resources instead of active ones

openvas_list_targets

List targets · read-only

List scan targets. Returns summarized rows plus pagination; use openvas_get_target for full details of one target.

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_web_application_targets

List web application targets · read-only

List web application targets. trash lists trashed ones.

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)
trash	boolean	no	List trashed resources instead of active ones

openvas_update_oci_image_target

Update OCI image target · destructive

Update an OCI image target. Idempotent (PUT): omitted fields stay unchanged.

Parameter	Type	Required	Description
comment	string	no
credential_id	string	no
id	string	yes	UUID of the OCI image target to update
image_references	array	no	Replacement image references (at least one)
name	string	no

openvas_update_target

Update target · destructive

Update a scan target. Idempotent (PUT): omitted fields stay unchanged; fails with 404 if the target does not exist, 409 if it is in use.

Parameter	Type	Required	Description
alive_test	string	no	Alive test method (same values as openvas_create_target)
comment	string	no
esxi_credential_id	string	no
exclude_hosts	array	no
hosts	array	no	Replacement host entries
id	string	yes	UUID of the target to update
name	string	no
port_list_id	string	no
reverse_lookup_only	boolean	no
reverse_lookup_unify	boolean	no
smb_credential_id	string	no
snmp_credential_id	string	no
ssh_credential_id	string	no

openvas_update_web_application_target

Update web application target · destructive

Update a web application target. Idempotent (PUT): omitted fields stay unchanged.

Parameter	Type	Required	Description
comment	string	no
credential_id	string	no
exclude_urls	array	no
id	string	yes	UUID of the web application target to update
name	string	no
urls	array	no	Replacement start URLs (at least one)