Get Alarm Summary
To retrieve a summary of alarm statistics for a client, site, or device:
- Log in to the REST API server using administrator credentials. You must also forward the session ID variable with each API call.
-
Use the GET method to access the alarmconfig/summary
endpoint and fetch the alarm statistics as a summary.
Sample Request
curl -X GET --cookie auth_token=$cookie http://134.141.242.93/nsight-ui/api /v1/alarmconfig/summary?treeSelection=%2FSystem&level=site&page=1&limit=30
Query String Parameters
Parameter Required/Optional Description Data Type treeSelection Required Used to filter the results in the response. Possible values are: - /System: Returns results for all sites.
- /System/<site>: Returns results for a specific site.
String level Required Site, device, or client String page Optional Number of pages Integer limit Optional Number of items per page Integer Sample Response (200 OK)
{ "success": true, "data":[ { "_id":"1001", "active_alarms":1, "critical_alarms":0, "major_alarms":1, "minor_alarms":0 }, { "_id":"1002", "active_alarms":1, "critical_alarms":0, "major_alarms":1, "minor_alarms":0 }, { "_id":"1003", "active_alarms":1, "critical_alarms":0, "major_alarms":1, "minor_alarms":0 }, { "_id":"1004", "active_alarms":1, "critical_alarms":0, "major_alarms":1, "minor_alarms":0 }, { "_id":"1005", "active_alarms":1, "critical_alarms":0, "major_alarms":1, "minor_alarms":0 }, { "_id":"default", "active_alarms":1, "critical_alarms":0, "major_alarms":1, "minor_alarms":0 }, { "_id":"test", "active_alarms":1, "critical_alarms":0, "major_alarms":1, "minor_alarms":0 }], "total":7 }