Last modified October 31, 2024

Alerts


listAlerts

This function lists all Alert Objects.

getAlert

This function prints the objects data given its Alert ID.

clearAlerts

This function deletes all Alert Objects.

Parameter Dictionary

Alert Object

Parameter name Type Description Possible Values Example
title String The unique title for the alert.   'Backup job "Local" completed successfully'
message String The message that is sent for the alert.   'The backup job "Local" (#607458c5b743c715d0596752) completed successfully'
find[level] Integer The type of alert being sent.
Information 1
Warning 2
Critical 4
1
created Date The corresponding date/time the alert was sent.   2021-04-19T17:17:21+00:00
owner String The owner id for the owner of the alert.   6079ab6b49bdec64d20a3833
owner_name String The name of the owner matching the owner id.   root