filters

Saved filters.

• Toolset name: filters

• Enabled by default: yes

• Tools: 6 (2 read-only)

Tools

openvas_clone_filter

Clone filter · mutating

Clone a saved filter. Returns the UUID of the copy.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_create_filter

Create filter · mutating

Create a saved filter. Not idempotent.

Parameter	Type	Required	Description
comment	string	no	Optional comment
name	string	yes	Filter name
term	string	no	GMP filter term, e.g. severity>7 and host=10.0.0.5
type	string	no	Resource type the filter applies to, e.g. “result”, “task”, “report”

openvas_delete_filter

Delete filter · destructive

Delete a saved filter (to the trashcan by default; ultimate deletes permanently). Fails with 409 if an alert 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_filter

Get filter · read-only

Get one saved filter by UUID.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_list_filters

List filters · read-only

List saved filters (reusable GMP filter expressions).

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_filter

Update filter · destructive

Update a saved filter’s term, type or comment. Idempotent (PUT).

Parameter	Type	Required	Description
comment	string	no
id	string	yes	UUID of the filter to update
term	string	no	Replacement GMP filter term
type	string	no	Replacement resource type