alert

Description: alert settings: ARRAY

Element Type Description
alerts ARRAY List of notifications available for configuration
groups ARRAY List of recipient groups that receive notifications.
name STRING Recipient group name
emails ARRAY List of recipient emails
name STRING Recipient name
email STRING Recipient email address
phones ARRAY List of recipient phone numbers
name STRING Recipient name
phone STRING Recipient phone number

The alerts array contains predefined number of elements; each defines settings for particular type of alert. A set of settings applicable for different alert types is different.

Alert Types

 High Data Usage Alert 

Element Type Description
alertOn INT Data usage amount in % when device should send an alert (default : 80)
dataAllowedPerMonth INT Amount of data allowed per month in data plan in Mb
dataPlanStartDate INT A day of month when data plan resets (default : 1)
dataPlanType STRING Billing cycle type, use “Monthly” to set the day of the month when the billing cycle starts, or “Custom Interval” to set the number of days in the billing cycle (default : Monthly)
email BOOL enable or disable sending notifications by email (default:false)
enabled BOOL enable or disable notification (default:false)
event STRING “Data Usage”
interval INT For the Data Usage it is the number of days in the billing cycle interval when data plan resets (default:30)
intervalStartDate STRING Day of the beginning of billing cycle for data plan with “Custom Interval” type
notifyGroup STRING The name of recipient group that receives notification.
sms BOOL Enable or disable sending notifications via sms (default : false)
snmp BOOL enable or disable sending SNMP trap notifications (default : false)


Low Signal Strength Alert
 

Element Type Description
email BOOL enable or disable sending notifications by email (default:false)
enabled BOOL enable or disable notification (default:false)
event STRING “Signal Strength”
interval INT Amount of time in seconds for signal strength threshold before issuing alert (default : 60)
minWaitTimeAfterAlarm INT Interval in hours before subsequent notifications for the low signal strength event are issued (default : 24)
notifyGroup STRING The name of recipient group that receives notification.
signalStrength INT Signal strength threshold in dBm (default:-60)
sms BOOL Enable or disable sending notifications via sms (default : false)
snmp BOOL enable or disable sending SNMP trap notifications (default : false)


Device Reboots Alert
 

Element Type Description
email BOOL enable or disable sending notifications by email (default:false)
enabled BOOL enable or disable notification (default:false)
event STRING “Device Reboot”
notifyGroup STRING The name of recipient group that receives notification.
sms BOOL Enable or disable sending notifications via sms (default : false)
snmp BOOL enable or disable sending SNMP trap notifications (default : false)


Ethernet Interface Failure Alert
 

Element Type Description
email BOOL enable or disable sending notifications by email (default:false)
enabled BOOL enable or disable notification (default:false)
event STRING “Ethernet Failure”
interval INT The amount of time in seconds when a notification should be sent (default:60)
minWaitTimeAfterAlarm INT Interval in hours before subsequent notifications for the Ethernet Failure  events are issued (default : 24)
notifyGroup STRING The name of recipient group that receives notification.
sms BOOL Enable or disable sending notifications via sms (default : false)
snmp BOOL enable or disable sending SNMP trap notifications (default : false)


WiFi Interface Failure Alert
 

Element Type Description
email BOOL enable or disable sending notifications by email (default:false)
enabled BOOL enable or disable notification (default:false)
event STRING “WifiWan Failure”
interval INT The amount of time in seconds when a notification should be sent (default:60)
minWaitTimeAfterAlarm INT Interval in hours before subsequent notifications for the Ethernet Failure  events are issued (default : 24)
notifyGroup STRING The name of recipient group that receives notification.
sms BOOL Enable or disable sending notifications via sms (default : false)
snmp BOOL enable or disable sending SNMP trap notifications (default : false)


Cellular Interface Failure Alert
 

Element Type Description
email BOOL enable or disable sending notifications by email (default:false)
enabled BOOL enable or disable notification (default:false)
event STRING “Cellular Failure”
interval INT The amount of time in seconds when a notification should be sent (default:60)
minWaitTimeAfterAlarm INT Interval in hours before subsequent notifications for the Ethernet Failure  events are issued (default : 24)
notifyGroup STRING The name of recipient group that receives notification.
sms BOOL Enable or disable sending notifications via sms (default : false)
snmp BOOL enable or disable sending SNMP trap notifications (default : false)

Ethernet Data Traffic Alert 

Element Type Description
email BOOL enable or disable sending notifications by email (default:false)
enabled BOOL enable or disable notification (default:false)
event STRING “Ethernet Traffic”
notifyGroup STRING The name of recipient group that receives notification.
periodicInterval INT Interval in hours between notifications for data traffic notifications (default:24)
sms BOOL Enable or disable sending notifications via sms (default : false)


WiFi Data Traffic Alert
 

Element Type Description
email BOOL enable or disable sending notifications by email (default:false)
enabled BOOL enable or disable notification (default:false)
event STRING “Wifi Traffic”
notifyGroup STRING The name of recipient group that receives notification.
periodicInterval INT Interval in hours between notifications for data traffic notifications (default:24)
sms BOOL Enable or disable sending notifications via sms (default : false)

 

Cellular Data Traffic Alert 

Element Type Description
email BOOL enable or disable sending notifications by email (default:false)
enabled BOOL enable or disable notification (default:false)
event STRING “Cellular Traffic”
notifyGroup STRING The name of recipient group that receives notification.
periodicInterval INT Interval in hours between notifications for data traffic notifications (default:24)
sms BOOL Enable or disable sending notifications via sms (default : false)


WAN Interface Failover Data Traffic Alert
 

Element Type Description
email BOOL enable or disable sending notifications by email (default:false)
enabled BOOL enable or disable notification (default:false)
event STRING “WAN Failover”
failoverEvent STRING Wan Failover alert trigger. Valid values are ‘Always’, ‘Interface went down’ and ‘Interface came up’. ‘Always’ – the notification is sent every time when WAN Transport is changed; ‘Interface went down’ – the notification is sent only when the current interface is switched to the one that has lower priority; ‘Interface came up’ – the notification is sent only when the current interface is switched to the one that has higher priority. (default:’Always’)
minWaitTimeAfterStart INT The period of time in seconds during which the system does not monitor WAN failover statuses on start-up (default:60)
notifyGroup STRING The name of recipient group that receives notification.
sms BOOL Enable or disable sending notifications via sms (default : false)
snmp BOOL enable or disable sending SNMP trap notifications (default : false)

 

 Periodic Ping Failure Alert 

Element Type Description
count INT The number of requests that must be sent (default : 10)
email BOOL enable or disable sending notifications by email (default:false)
enabled BOOL enable or disable notification (default:false)
event STRING “Ping Failure”
failThreshold INT The number of failed requests that will trigger the notification (default : 10)
ipAddress STRING IP Address or hostname (default : google.com)
netIface STRING The notification will be sent through the specified interface (default : “ANY”)
notifyGroup STRING The name of recipient group that receives notification.
pingInterval INT Interval in minutes for performing ping test (default : 10)
sms BOOL Enable or disable sending notifications via sms (default : false)
snmp BOOL enable or disable sending SNMP trap notifications (default : false)

 

Example of changing Device Reboot Alert settings using MTR API is below.
Request:

https://192.168.2.1/api/alert/alerts?data={ “event” : “Device Reboot” , “email” : false, “enabled” : false, “notifyGroup” : “” , “sms” : false, “snmp”: false }&method=PUT

Response:
{
“code” : 200,
“status” : “success”
}