notes

Notes on results.

• Toolset name: notes

• Enabled by default: yes

• Tools: 5 (2 read-only)

Tools

openvas_create_note

Create note · mutating

Create a note on an NVT, optionally scoped to hosts, a port, a task or a specific result. Not idempotent.

Parameter	Type	Required	Description
active	boolean	no	Whether the note is active
hosts	array	no	Restrict to these hosts
nvt_oid	string	yes	OID of the NVT the note applies to
orphan	boolean	no	Keep the note even when its result no longer exists
port	string	no	Restrict to a port, e.g. “22/tcp”
result_id	string	no	Attach to one specific result by UUID
severity	string	no	Restrict to results with this severity (string per GMP, e.g. “7.5”)
task_id	string	no	Restrict to one task by UUID
text	string	no	Note text

openvas_delete_note

Delete note · destructive

Delete a note (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_note

Get note · read-only

Get one note by UUID.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_list_notes

List notes · read-only

List notes attached to scan results.

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_note

Update note · destructive

Update a note. Idempotent (PUT): omitted fields stay unchanged.

Parameter	Type	Required	Description
active	boolean	no
hosts	array	no
id	string	yes	UUID of the note to update
orphan	boolean	no
port	string	no
result_id	string	no
severity	string	no
task_id	string	no
text	string	no