tags

Tags on resources.

• Toolset name: tags

• Enabled by default: yes

• Tools: 6 (2 read-only)

Tools

openvas_clone_tag

Clone tag · mutating

Clone a tag. Returns the UUID of the copy.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_create_tag

Create tag · mutating

Create a tag, optionally attached to one resource. Not idempotent.

Parameter	Type	Required	Description
active	boolean	no	Whether the tag is active
comment	string	no	Optional comment
name	string	yes	Tag name, e.g. “owner” or “env:prod”
resource_id	string	no	UUID of the resource to attach to
resource_type	string	no	Type of the resource to attach to, e.g. “task”, “target”, “host”
value	string	no	Tag value

openvas_delete_tag

Delete tag · destructive

Delete a tag (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_tag

Get tag · read-only

Get one tag by UUID, including the resources it is attached to.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_list_tags

List tags · read-only

List tags attached to GVM resources.

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_tag

Update tag · destructive

Update a tag’s value, attachment or active flag. Idempotent (PUT).

Parameter	Type	Required	Description
active	boolean	no
comment	string	no
id	string	yes	UUID of the tag to update
resource_id	string	no
resource_type	string	no
value	string	no