Specific Active Alarm
Use the following URL to retrieve a specific active alarm.
URL
/api/v1/alarms/active/<id>
HTTP Method
GET
Supported Parameters
Parameter |
Type |
Description |
---|---|---|
?oid=<value> |
Number |
If value 1 is specified, response will include “oid” attribute that indicated OID of the corresponding SNMP trap. Default = 0. |
HTTP Responses
■ | 200 OK |
■ | 404 Not Found – when alarm is not found |
Example
■ | Request: |
GET /api/v1/alarms/active/1 HTTP/1.1 Host: 10.4.219.229
■ | Response: |
HTTP/1.1 200 OK Content-Type: application/json { "id": "1", "description": "Trunk is down", "severity": "Major", "source": "Board#1", "date": "2010-03-01T23:00:00.000Z", "url": "/api/v1/alarms/active/1" }