AlarmTraq REST API (v2)

General notes

Provides a set of HTTP endpoints that help you integrate with AlarmTraq. The API is sold separately as part of the secure alarming package.

API detail

POST /api/v2/securealarming 

curl -X POST -d '{  
	"WANIPAddress": "75.149.134.73",
	"SNMPVer": "Two",
	"SNMPType": "Snmp.NotificationMessage",
	"SnmpTrapOID":"1.3.6.1.4.1.6889.2.73.9.0.9",
	"SNMPTrapName": "avCmAlmAlarmTest",
	"SnmpEnterpriseOID": "1.3.6.1.4.1.6889.2.73.9",
	"SpecificTrap":"",
	"GenericCode":"",     
    "SnmpEnterpriseName":"avCmAlarmMib",     
	"CommunityString":"public",     
   	"trapDescription":"",     
   	"gwName":"agateway12345",     
   	"timeStamp":"08/25/2021 07:45 PM ",
    "Vars": [
                    {"varOid":"1.3.6.1.4.1.6889.2.73.9.1.1.1", "varValue":"IPV4=192.168.1.83 IPV6="},
                    {"varOid":"1.3.6.1.4.1.6889.2.73.9.1.1.2", "varValue":"cmserver80"},
                    {"varOid":"1.3.6.1.4.1.6889.2.73.9.1.1.3", "varValue":"1000000082"},
                    {"varOid":"1.3.6.1.4.1.6889.2.73.9.1.1.10", "varValue":"08/25"},
                    {"varOid":"1.3.6.1.4.1.6889.2.73.9.1.1.11", "varValue":"07:45:42"},
                    {"varOid":"1.3.6.1.4.1.6889.2.73.9.1.1.34", "varValue":"CUSTOMER ALARM TEST"},
                    {"varOid":"1.3.6.1.4.1.37137.2.70.1.1.43.0", "varValue":"64542686"},
                    {"varOid":"1.3.6.1.4.1.37137.2.70.1.1.41.0", "varValue":"192.168.1.83"}
            ]              
}' "https://www.domain.com/api/v2/securealarming"
POST /api/v2/securealarming HTTP/1.1
Host: www.domain.com

{  
	"WANIPAddress": "75.149.134.73",
	"SNMPVer": "Two",
	"SNMPType": "Snmp.NotificationMessage",
	"SnmpTrapOID":"1.3.6.1.4.1.6889.2.73.9.0.9",
	"SNMPTrapName": "avCmAlmAlarmTest",
	"SnmpEnterpriseOID": "1.3.6.1.4.1.6889.2.73.9",
	"SpecificTrap":"",
	"GenericCode":"",     
    "SnmpEnterpriseName":"avCmAlarmMib",     
	"CommunityString":"public",     
   	"trapDescription":"",     
   	"gwName":"agateway12345",     
   	"timeStamp":"08/25/2021 07:45 PM ",
    "Vars": [
                    {"varOid":"1.3.6.1.4.1.6889.2.73.9.1.1.1", "varValue":"IPV4=192.168.1.83 IPV6="},
                    {"varOid":"1.3.6.1.4.1.6889.2.73.9.1.1.2", "varValue":"cmserver80"},
                    {"varOid":"1.3.6.1.4.1.6889.2.73.9.1.1.3", "varValue":"1000000082"},
                    {"varOid":"1.3.6.1.4.1.6889.2.73.9.1.1.10", "varValue":"08/25"},
                    {"varOid":"1.3.6.1.4.1.6889.2.73.9.1.1.11", "varValue":"07:45:42"},
                    {"varOid":"1.3.6.1.4.1.6889.2.73.9.1.1.34", "varValue":"CUSTOMER ALARM TEST"},
                    {"varOid":"1.3.6.1.4.1.37137.2.70.1.1.43.0", "varValue":"64542686"},
                    {"varOid":"1.3.6.1.4.1.37137.2.70.1.1.41.0", "varValue":"192.168.1.83"}
            ]              
}

GET /api/v2/alarms 

curl -X GET "https://www.domain.com/api/v2/alarms"
GET /api/v2/alarms HTTP/1.1
Host: www.domain.com

GET /api/v2/alarms?productId=1234567890 

curl -X GET "https://www.domain.com/api/v2/alarms?productId=1234567890"
GET /api/v2/alarms?productId=1234567890 HTTP/1.1
Host: www.domain.com

GET /api/v2/alarms?productId=1234567890&num=1000 

curl -X GET "https://www.domain.com/api/v2/alarms?productId=1234567890&num=1000"
GET /api/v2/alarms?productId=1234567890&num=1000 HTTP/1.1
Host: www.domain.com

GET /api/v2/alarms?num=1000&str=hello 

curl -X GET "https://www.domain.com/api/v2/alarms?num=1000&str=hello"
GET /api/v2/alarms?num=1000&str=hello HTTP/1.1
Host: www.domain.com

GET /api/v2/productid/1234567890 

curl -X GET "https://www.domain.com/api/v2/productid/1234567890"
GET /api/v2/productid/1234567890 HTTP/1.1
Host: www.domain.com

GET /api/v2/productid 

curl -X GET "http://www.domain.com/api/v2/productid"
GET /api/v2/productid HTTP/1.1
Host: www.domain.com

GET /api/v2/device 

curl -X GET "https://www.domain.com/api/v2/device"
GET /api/v2/device HTTP/1.1
Host: www.domain.com

GET /api/v2/device/1 

curl -X GET "http://www.domain.com/api/v2/device/1"
GET /api/v2/device/1 HTTP/1.1 Host: www.domain.com