alerts

Alerts and notifications.

• Toolset name: alerts

• Enabled by default: yes

• Tools: 5 (2 read-only)

Tools

openvas_create_alert

Create alert · mutating

Create an alert binding an event, condition and method (e.g. email on task_run_status_changed with event_data {“status”: “Done”}). The event/condition/method values are the gateway’s snake_case identifiers. Not idempotent.

Parameter	Type	Required	Description
comment	string	no	Optional comment
condition	string	yes	Trigger condition: always, filter_count_at_least, filter_count_changed, severity_at_least or severity_changed
condition_data	object<string, string>	no	Condition parameters, e.g. {“severity”: “7.0”}
event	string	yes	Trigger event: task_run_status_changed, updated_secinfo or new_secinfo
event_data	object<string, string>	no	Event parameters, e.g. {“status”: “Done”}
filter_id	string	no	UUID of a filter restricting which results the alert reports
method	string	yes	Delivery method: email, http_get, scp, send_email, smb, snmp, sourcefire_connector, start_task, syslog, tippingpoint, verinice_ce, verinice_net or alemba
method_data	object<string, string>	no	Method parameters, e.g. {“to_address”: “sec@example.com”}
name	string	yes	Alert name

openvas_delete_alert

Delete alert · destructive

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

Get alert · read-only

Get one alert by UUID, including event/condition/method data.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_list_alerts

List alerts · read-only

List alerts (notifications triggered by task events).

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_alert

Update alert · destructive

Update an alert. Idempotent (PUT): omitted fields stay unchanged.

Parameter	Type	Required	Description
comment	string	no
condition	string	no	Same values as openvas_create_alert
condition_data	object<string, string>	no
event	string	no	Same values as openvas_create_alert
event_data	object<string, string>	no
filter_id	string	no
id	string	yes	UUID of the alert to update
method	string	no	Same values as openvas_create_alert
method_data	object<string, string>	no
name	string	no