Alarm APIs (Deprecated)

 

This endpoint has been deprecated, use the System Alerts endpoint instead. Refer to Alarms to System Alerts Migration for information on parameters mapping between the two endpoints.

Get Active Alarms

	GET /alarms/v1/smartview/alarms
Method	GET
Endpoint	/alarms/v1/smartview/alarms
Headers	Authorization
Path Parameters	Not applicable
Query Parameters	accountNo, groupByIBX, offset, limit
Body Parameters	Not applicable

This API request returns all active alarms that related to the IBX data center footprint associated with the specified customer account.

 

If you are unaware of how to obtain an authorization token, refer Requesting Access and Refresh tokens under Getting Access Token.

Sample curl request

curl -X 
GET "https://api.equinix.com/alarm/v1/smartview/alarms?accountNo=1&limit=10"
-H "authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2' 

Query parameters

Parameter	Description
accountNo string REQUIRED	Customer account number. Example: 1234
limit integer OPTIONAL	Maximum number of items returned per page. Example: 50
offset integer OPTIONAL	Index of the first item returned in the response. Example: 69
groupByIBX boolean OPTIONAL	Indicates if the alarms should be grouped by IBX data center. Example: true Default: false

Sample response

{
    "alarms": [
        {
            "ibx": "DC5",
            "accountNo": "1",
            "assetId": "DC5.UPS-R1",
            "assetType": "UPS",
            "assetClassification": "Electrical",
            "conditionName": "Alarm",
            "severity": "Urgent",
            "status": true,
            "ack": true,
            "tagId": "DC5.UPS-R1:alarm",
            "customerId": "ALL",
            "timeProcessed": 1550519327497,
            "timeTrigerred": 1546510663707,
            "timeNormalProcessed": 0
        },
        {
            "ibx": "CH3",
            "accountNo": "1",
            "assetId": "CH3.PDU-A3.A5",
            "assetType": "PDU",
            "assetClassification": "Electrical",
            "conditionName": "Alarm",
            "severity": "Urgent",
            "status": true,
            "ack": true,
            "tagId": "CH3.PDU-A3.A5:alarm",
            "customerId": "ALL",
            "timeProcessed": 1550322722748,
            "timeTrigerred": 1550071367746,
            "timeNormalProcessed": 0
        },
        {
            "ibx": "CH3",
            "accountNo": "1",
            "assetId": "CH3.STS-B1.A5",
            "assetType": "ASTS",
            "assetClassification": "Electrical",
            "conditionName": "Alarm",
            "severity": "Urgent",
            "status": false,
            "ack": false,
            "tagId": "CH3.STS-B1.A5:alarm",
            "customerId": "ALL",
            "timeProcessed": 1550509311772,
            "timeTrigerred": 1546342538650,
            "timeNormalProcessed": 1550509435530
        }
    ],
    "groupedAlarms": null,
    "totalCount": 2389
}

Response payload body description

Parameter	Description
alarms array[object]	Alarm objects array.
accountNo string	Customer account number. Example: 135888
assetId string	Asset identifier. Example: DC5.UPS-R1
assetType string	Asset type. Example: cooling
assetClassification string	Asset classification category. Example: Electrical
conditionName string	Alarm trigger condition. Example: ALARM
ibx string	IBX data center where the given asset is located. Example: DC5
status boolean	Alarm status. Example: true
tagId string	Unique tag point identifier. Example: CH1.Chiller1:evapleavingwatertemperature
timeProcessed string	Date and time at which the alarm was processed. Example: Aug 21,2017 04:38 AM
timeNormalProcessed string	Date and time at which the normal condition was restored. Example: Aug 21,2017 04:43 AM
groupedAlarms array[object]	Grouped alarms objects array.
totalCount integer	Total numbers of alarms. Example: 1337

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Smart View portal access.