{"id":18385,"date":"2017-04-19T15:58:41","date_gmt":"2017-04-19T20:58:41","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=18385"},"modified":"2022-08-02T12:05:23","modified_gmt":"2022-08-02T17:05:23","slug":"alert","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/mtr-software\/mtr-api-reference\/collection-endpoints\/alert\/","title":{"rendered":"alert"},"content":{"rendered":"

Description: alert settings: ARRAY<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n
Element<\/strong><\/td>\nType<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
alerts<\/td>\nARRAY<\/td>\nList of notifications available for configuration<\/td>\n<\/tr>\n
groups<\/td>\nARRAY<\/td>\nList of recipient groups that receive notifications.<\/td>\n<\/tr>\n
name<\/td>\nSTRING<\/td>\nRecipient group name<\/td>\n<\/tr>\n
emails<\/td>\nARRAY<\/td>\nList of recipient emails<\/td>\n<\/tr>\n
name<\/td>\nSTRING<\/td>\nRecipient name<\/td>\n<\/tr>\n
email<\/td>\nSTRING<\/td>\nRecipient email address<\/td>\n<\/tr>\n
phones<\/td>\nARRAY<\/td>\nList of recipient phone numbers<\/td>\n<\/tr>\n
name<\/td>\nSTRING<\/td>\nRecipient name<\/td>\n<\/tr>\n
phone<\/td>\nSTRING<\/td>\nRecipient phone number<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

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.<\/p>\n

Alert Types<\/h3>\n

\u00a0High Data Usage Alert<\/span>\u00a0<\/strong><\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Element<\/strong><\/td>\nType<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
alertOn<\/td>\nINT<\/td>\nData usage amount in % when device should send an alert (default : 80)<\/td>\n<\/tr>\n
dataAllowedPerMonth<\/td>\nINT<\/td>\nAmount of data allowed per month in data plan in Mb<\/td>\n<\/tr>\n
dataPlanStartDate<\/td>\nINT<\/td>\nA day of month when data plan resets (default : 1)<\/td>\n<\/tr>\n
dataPlanType<\/td>\nSTRING<\/td>\nBilling cycle type, use \u201cMonthly\u201d to set the day of the month when the billing cycle starts, or \u201cCustom Interval\u201d to set the number of days in the billing cycle (default : Monthly)<\/td>\n<\/tr>\n
email<\/td>\nBOOL<\/td>\nenable or disable sending notifications by email (default:false)<\/td>\n<\/tr>\n
enabled<\/td>\nBOOL<\/td>\nenable or disable notification (default:false)<\/td>\n<\/tr>\n
event<\/td>\nSTRING<\/td>\n“Data Usage”<\/td>\n<\/tr>\n
interval<\/td>\nINT<\/td>\nFor the Data Usage it is the number of days in the billing cycle interval when data plan resets (default:30)<\/td>\n<\/tr>\n
intervalStartDate<\/td>\nSTRING<\/td>\nDay of the beginning of billing cycle for data plan with \u201cCustom Interval\u201d type<\/td>\n<\/tr>\n
notifyGroup<\/td>\nSTRING<\/td>\nThe name of recipient group that receives notification.<\/td>\n<\/tr>\n
sms<\/td>\nBOOL<\/td>\nEnable or disable sending notifications via sms (default : false)<\/td>\n<\/tr>\n
snmp<\/td>\nBOOL<\/td>\nenable or disable sending SNMP trap notifications (default : false)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n


\nLow Signal Strength Alert<\/span>\u00a0<\/strong><\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n
Element<\/strong><\/td>\nType<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
email<\/td>\nBOOL<\/td>\nenable or disable sending notifications by email (default:false)<\/td>\n<\/tr>\n
enabled<\/td>\nBOOL<\/td>\nenable or disable notification (default:false)<\/td>\n<\/tr>\n
event<\/td>\nSTRING<\/td>\n“Signal Strength”<\/td>\n<\/tr>\n
interval<\/td>\nINT<\/td>\nAmount of time in seconds for signal strength threshold before issuing alert (default : 60)<\/td>\n<\/tr>\n
minWaitTimeAfterAlarm<\/td>\nINT<\/td>\nInterval in hours before subsequent notifications for the low signal strength event are issued (default : 24)<\/td>\n<\/tr>\n
notifyGroup<\/td>\nSTRING<\/td>\nThe name of recipient group that receives notification.<\/td>\n<\/tr>\n
signalStrength<\/td>\nINT<\/td>\nSignal strength threshold in dBm (default:-60)<\/td>\n<\/tr>\n
sms<\/td>\nBOOL<\/td>\nEnable or disable sending notifications via sms (default : false)<\/td>\n<\/tr>\n
snmp<\/td>\nBOOL<\/td>\nenable or disable sending SNMP trap notifications (default : false)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n


\nDevice Reboots Alert<\/span>\u00a0<\/strong><\/p>\n\n\n\n\n\n\n\n\n\n
Element<\/strong><\/td>\nType<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
email<\/td>\nBOOL<\/td>\nenable or disable sending notifications by email (default:false)<\/td>\n<\/tr>\n
enabled<\/td>\nBOOL<\/td>\nenable or disable notification (default:false)<\/td>\n<\/tr>\n
event<\/td>\nSTRING<\/td>\n“Device Reboot”<\/td>\n<\/tr>\n
notifyGroup<\/td>\nSTRING<\/td>\nThe name of recipient group that receives notification.<\/td>\n<\/tr>\n
sms<\/td>\nBOOL<\/td>\nEnable or disable sending notifications via sms (default : false)<\/td>\n<\/tr>\n
snmp<\/td>\nBOOL<\/td>\nenable or disable sending SNMP trap notifications (default : false)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n


\nEthernet Interface Failure Alert<\/span>\u00a0<\/strong><\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Element<\/strong><\/td>\nType<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
email<\/td>\nBOOL<\/td>\nenable or disable sending notifications by email (default:false)<\/td>\n<\/tr>\n
enabled<\/td>\nBOOL<\/td>\nenable or disable notification (default:false)<\/td>\n<\/tr>\n
event<\/td>\nSTRING<\/td>\n“Ethernet Failure”<\/td>\n<\/tr>\n
interval<\/td>\nINT<\/td>\nThe amount of time in seconds when a notification should be sent (default:60)<\/td>\n<\/tr>\n
minWaitTimeAfterAlarm<\/td>\nINT<\/td>\nInterval in hours before subsequent notifications for the Ethernet Failure \u00a0events are issued (default : 24)<\/td>\n<\/tr>\n
notifyGroup<\/td>\nSTRING<\/td>\nThe name of recipient group that receives notification.<\/td>\n<\/tr>\n
sms<\/td>\nBOOL<\/td>\nEnable or disable sending notifications via sms (default : false)<\/td>\n<\/tr>\n
snmp<\/td>\nBOOL<\/td>\nenable or disable sending SNMP trap notifications (default : false)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n


\nWiFi Interface Failure Alert<\/span>\u00a0<\/strong><\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Element<\/strong><\/td>\nType<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
email<\/td>\nBOOL<\/td>\nenable or disable sending notifications by email (default:false)<\/td>\n<\/tr>\n
enabled<\/td>\nBOOL<\/td>\nenable or disable notification (default:false)<\/td>\n<\/tr>\n
event<\/td>\nSTRING<\/td>\n“WifiWan Failure”<\/td>\n<\/tr>\n
interval<\/td>\nINT<\/td>\nThe amount of time in seconds when a notification should be sent (default:60)<\/td>\n<\/tr>\n
minWaitTimeAfterAlarm<\/td>\nINT<\/td>\nInterval in hours before subsequent notifications for the Ethernet Failure \u00a0events are issued (default : 24)<\/td>\n<\/tr>\n
notifyGroup<\/td>\nSTRING<\/td>\nThe name of recipient group that receives notification.<\/td>\n<\/tr>\n
sms<\/td>\nBOOL<\/td>\nEnable or disable sending notifications via sms (default : false)<\/td>\n<\/tr>\n
snmp<\/td>\nBOOL<\/td>\nenable or disable sending SNMP trap notifications (default : false)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n


\nCellular Interface Failure Alert<\/span>\u00a0<\/strong><\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Element<\/strong><\/td>\nType<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
email<\/td>\nBOOL<\/td>\nenable or disable sending notifications by email (default:false)<\/td>\n<\/tr>\n
enabled<\/td>\nBOOL<\/td>\nenable or disable notification (default:false)<\/td>\n<\/tr>\n
event<\/td>\nSTRING<\/td>\n“Cellular Failure”<\/td>\n<\/tr>\n
interval<\/td>\nINT<\/td>\nThe amount of time in seconds when a notification should be sent (default:60)<\/td>\n<\/tr>\n
minWaitTimeAfterAlarm<\/td>\nINT<\/td>\nInterval in hours before subsequent notifications for the Ethernet Failure \u00a0events are issued (default : 24)<\/td>\n<\/tr>\n
notifyGroup<\/td>\nSTRING<\/td>\nThe name of recipient group that receives notification.<\/td>\n<\/tr>\n
sms<\/td>\nBOOL<\/td>\nEnable or disable sending notifications via sms (default : false)<\/td>\n<\/tr>\n
snmp<\/td>\nBOOL<\/td>\nenable or disable sending SNMP trap notifications (default : false)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Ethernet Data Traffic Alert<\/span>\u00a0<\/strong><\/p>\n\n\n\n\n\n\n\n\n\n
Element<\/strong><\/td>\nType<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
email<\/td>\nBOOL<\/td>\nenable or disable sending notifications by email (default:false)<\/td>\n<\/tr>\n
enabled<\/td>\nBOOL<\/td>\nenable or disable notification (default:false)<\/td>\n<\/tr>\n
event<\/td>\nSTRING<\/td>\n“Ethernet Traffic”<\/td>\n<\/tr>\n
notifyGroup<\/td>\nSTRING<\/td>\nThe name of recipient group that receives notification.<\/td>\n<\/tr>\n
periodicInterval<\/td>\nINT<\/td>\nInterval in hours between notifications for data traffic notifications (default:24)<\/td>\n<\/tr>\n
sms<\/td>\nBOOL<\/td>\nEnable or disable sending notifications via sms (default : false)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n


\nWiFi Data Traffic Alert<\/span>\u00a0<\/strong><\/p>\n\n\n\n\n\n\n\n\n\n
Element<\/strong><\/td>\nType<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
email<\/td>\nBOOL<\/td>\nenable or disable sending notifications by email (default:false)<\/td>\n<\/tr>\n
enabled<\/td>\nBOOL<\/td>\nenable or disable notification (default:false)<\/td>\n<\/tr>\n
event<\/td>\nSTRING<\/td>\n“Wifi Traffic”<\/td>\n<\/tr>\n
notifyGroup<\/td>\nSTRING<\/td>\nThe name of recipient group that receives notification.<\/td>\n<\/tr>\n
periodicInterval<\/td>\nINT<\/td>\nInterval in hours between notifications for data traffic notifications (default:24)<\/td>\n<\/tr>\n
sms<\/td>\nBOOL<\/td>\nEnable or disable sending notifications via sms (default : false)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

Cellular Data Traffic Alert<\/span>\u00a0<\/strong><\/p>\n\n\n\n\n\n\n\n\n\n
Element<\/strong><\/td>\nType<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
email<\/td>\nBOOL<\/td>\nenable or disable sending notifications by email (default:false)<\/td>\n<\/tr>\n
enabled<\/td>\nBOOL<\/td>\nenable or disable notification (default:false)<\/td>\n<\/tr>\n
event<\/td>\nSTRING<\/td>\n“Cellular Traffic”<\/td>\n<\/tr>\n
notifyGroup<\/td>\nSTRING<\/td>\nThe name of recipient group that receives notification.<\/td>\n<\/tr>\n
periodicInterval<\/td>\nINT<\/td>\nInterval in hours between notifications for data traffic notifications (default:24)<\/td>\n<\/tr>\n
sms<\/td>\nBOOL<\/td>\nEnable or disable sending notifications via sms (default : false)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n


\nWAN Interface Failover Data Traffic Alert<\/span>\u00a0<\/strong><\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Element<\/td>\nType<\/td>\nDescription<\/td>\n<\/tr>\n
email<\/td>\nBOOL<\/td>\nenable or disable sending notifications by email (default:false)<\/td>\n<\/tr>\n
enabled<\/td>\nBOOL<\/td>\nenable or disable notification (default:false)<\/td>\n<\/tr>\n
event<\/td>\nSTRING<\/td>\n“WAN Failover”<\/td>\n<\/tr>\n
failoverEvent<\/td>\nSTRING<\/td>\nWan 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’)<\/td>\n<\/tr>\n
minWaitTimeAfterStart<\/td>\nINT<\/td>\nThe period of time in seconds during which the system does not monitor WAN failover statuses on start-up (default:60)<\/td>\n<\/tr>\n
notifyGroup<\/td>\nSTRING<\/td>\nThe name of recipient group that receives notification.<\/td>\n<\/tr>\n
sms<\/td>\nBOOL<\/td>\nEnable or disable sending notifications via sms (default : false)<\/td>\n<\/tr>\n
snmp<\/td>\nBOOL<\/td>\nenable or disable sending SNMP trap notifications (default : false)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

\u00a0Periodic Ping Failure Alert<\/span>\u00a0<\/strong><\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Element<\/strong><\/td>\nType<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
count<\/td>\nINT<\/td>\nThe number of requests that must be sent (default : 10)<\/td>\n<\/tr>\n
email<\/td>\nBOOL<\/td>\nenable or disable sending notifications by email (default:false)<\/td>\n<\/tr>\n
enabled<\/td>\nBOOL<\/td>\nenable or disable notification (default:false)<\/td>\n<\/tr>\n
event<\/td>\nSTRING<\/td>\n“Ping Failure”<\/td>\n<\/tr>\n
failThreshold<\/td>\nINT<\/td>\nThe number of failed requests that will trigger the notification (default : 10)<\/td>\n<\/tr>\n
ipAddress<\/td>\nSTRING<\/td>\nIP Address or hostname (default : google.com)<\/td>\n<\/tr>\n
netIface<\/td>\nSTRING<\/td>\nThe notification will be sent through the specified interface (default : \u201cANY\u201d)<\/td>\n<\/tr>\n
notifyGroup<\/td>\nSTRING<\/td>\nThe name of recipient group that receives notification.<\/td>\n<\/tr>\n
pingInterval<\/td>\nINT<\/td>\nInterval in minutes for performing ping test (default : 10)<\/td>\n<\/tr>\n
sms<\/td>\nBOOL<\/td>\nEnable or disable sending notifications via sms (default : false)<\/td>\n<\/tr>\n
snmp<\/td>\nBOOL<\/td>\nenable or disable sending SNMP trap notifications (default : false)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

Security Violation Alert\u00a0<\/strong><\/p>\n\n\n\n\n\n\n\n\n\n
Element<\/strong><\/td>\nType<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
event<\/td>\n<\/td>\n“Security Violation”<\/td>\n<\/tr>\n
enabled<\/td>\nBOOL<\/td>\nenable or disable notification (default:false)<\/td>\n<\/tr>\n
email<\/td>\nBOOL<\/td>\nenable or disable sending notifications by email (default:false)<\/td>\n<\/tr>\n
sms<\/td>\nBOOL<\/td>\nEnable or disable sending notifications via sms (default : false)<\/td>\n<\/tr>\n
snmp<\/td>\nBOOL<\/td>\nenable or disable sending SNMP trap notifications (default : false)<\/td>\n<\/tr>\n
notifyGroup<\/td>\nSTRING<\/td>\nThe name of recipient group that receives notification.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Flash Memory Violation Alert\u00a0<\/strong><\/p>\n\n\n\n\n\n\n\n\n\n
Element<\/strong><\/td>\nType<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
event<\/td>\n<\/td>\n“Flash Memory Violation”<\/td>\n<\/tr>\n
enabled<\/td>\nBOOL<\/td>\nenable or disable notification (default:false)<\/td>\n<\/tr>\n
email<\/td>\nBOOL<\/td>\nenable or disable sending notifications by email (default:false)<\/td>\n<\/tr>\n
sms<\/td>\nBOOL<\/td>\nEnable or disable sending notifications via sms (default : false)<\/td>\n<\/tr>\n
snmp<\/td>\nBOOL<\/td>\nenable or disable sending SNMP trap notifications (default : false)<\/td>\n<\/tr>\n
notifyGroup<\/td>\nSTRING<\/td>\nThe name of recipient group that receives notification.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Resources Overuse Alert\u00a0<\/strong><\/p>\n\n\n\n\n\n\n\n\n\n
Element<\/strong><\/td>\nType<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
event<\/td>\n<\/td>\n“Resources Overuse”<\/td>\n<\/tr>\n
enabled<\/td>\nBOOL<\/td>\nenable or disable notification (default:false)<\/td>\n<\/tr>\n
email<\/td>\nBOOL<\/td>\nenable or disable sending notifications by email (default:false)<\/td>\n<\/tr>\n
sms<\/td>\nBOOL<\/td>\nEnable or disable sending notifications via sms (default : false)<\/td>\n<\/tr>\n
snmp<\/td>\nBOOL<\/td>\nenable or disable sending SNMP trap notifications (default : false)<\/td>\n<\/tr>\n
notifyGroup<\/td>\nSTRING<\/td>\nThe name of recipient group that receives notification.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

Example of changing Device Reboot Alert settings using MTR API is below.
\nRequest:<\/p>\n

https:\/\/192.168.2.1\/api\/alert\/alerts?data={ “event” : “Device Reboot” , “email” : false, “enabled” : false, “notifyGroup” : “” , “sms” : false, \u201csnmp\u201d: false }&method=PUT<\/p>\n

Response: { “code” : 200, “status” : “success” }<\/p>\n","protected":false},"excerpt":{"rendered":"

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 […]<\/p>\n","protected":false},"author":1478,"featured_media":0,"parent":13129,"menu_order":2,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-18385","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/18385","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/users\/1478"}],"replies":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/comments?post=18385"}],"version-history":[{"count":8,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/18385\/revisions"}],"predecessor-version":[{"id":26113,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/18385\/revisions\/26113"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13129"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=18385"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}