Skip to main content
Index

Alarm APIs

GET Active Alarms

GET /alarms/v1/smartview/alarms

 Method  GET
 URL or End Point  /alarms/v1/smartview/alarms
 Headers  Authorization, Content-Type
 Query Parameters  accountNo, ibx
 Body  Not applicable

 

Given a customer account, retrieve all the active alarms. A total count specifying the number of alarms and a list of alarms is returned. If groupByIBX was set to true, then a list of alarm groups is returned. The assetClassification, timeProcessed, conditionName, assetType, tagId, timeNormalProcessed and assetId are returned.

 

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

 

The following screenshots show a sample curl request to get all active alarms and a JSON response containing the result. 

 

curl -X 

GET "https://api.equinix.com/alarm/v1/smartview/alarms?accountNo=1&limit=10"     

-H "content-type: application/json"

-H "authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2' 

 

The description of the query parameters is as follows:

 

Query Parameter Name Mandatory Type Example Applicable values Description
accountNo Y string 1234   Customer account number
ibx Y string AB2  

Name of the IBX for which data is being requested.

limit N integer 0   Specifies the number of records to be retreived.
offset N integer 0   Specifies the index of the starting record.
groupByIBX N boolean true false, true Indicates if the alarms should be grouped by IBX.

 


{
    "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,
            "customerassets": []
        },
        {
            "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,
            "customerassets": []
        },
        {
            "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,
            "customerassets": []
        }
    ],
    "groupedAlarms": null,
    "totalCount": 2389
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
alarms array   Array of alarms.
accountNo string 1234 Customer account number.
assetId string CH1.FC2 Indicates the unique identifier for the asset.
assetType string

cooling  

Indicates the template name for the asset.
assetClassificastion string Environmental The class of assets this asset belongs to.
conditionName string High Name given to the alarm condition.
ibx string CH1 The IBX at which the alarm occured.
status boolean true Alarm status.
tagId string CH1.Chiller1:evapleavingwatertemperature Unique identifier for the tag point.
timeProcessed string

Aug 21,2017 04:38 AM

Date-time at which the alarm was processed at tbe IBX.
timeNormalProcessed string

Aug 21,2017 05:52 AM

Date-time at which the normal condition was restored at the IBX.
totalCount integer 10 Total number of alarms

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix IBX SmartView Portal access.