port-lists

Port lists.

• Toolset name: port-lists

• Enabled by default: yes

• Tools: 5 (2 read-only)

Tools

openvas_create_port_list

Create port list · mutating

Create a port list from a range expression like “T:1-1000,U:53,T:8080”. Not idempotent.

Parameter	Type	Required	Description
comment	string	no	Optional comment
name	string	yes	Port list name
port_range	string	no	Port range expression, e.g. “T:1-1000,U:53”

openvas_delete_port_list

Delete port list · destructive

Delete a port list (to the trashcan by default; ultimate deletes permanently). Fails with 409 if a target 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_port_list

Get port list · read-only

Get one port list by UUID, including its port ranges.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_list_port_lists

List port lists · read-only

List port lists targets can scan.

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_port_list

Update port list · destructive

Update a port list’s name, comment or ranges. Idempotent (PUT).

Parameter	Type	Required	Description
comment	string	no
id	string	yes	UUID of the port list to update
name	string	no
port_range	string	no	Replacement port range expression, e.g. “T:1-1000,U:53”