Skip to main content
Index

Get All Alarms over Rest API

Step 1: Authenticate

Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication.

 

Refer to Generating Client ID and Client Secret key under Getting Started section for instructions on how to create client ID and client secret. Refer to Requesting Access and Refresh tokens for instructions on how to call Oauth API to validate and authenticate your credentials.

 

If you are unaware of your user credentials for Equinix IBX SmartView, contact your local Equinix Service Desk. 

Step 2: Get a list of all the alarms

Alarms API provides one endpoint Get all active alarms. Using this endpoint you can retrieve all the alarms that have triggered on all assets serving your colocation footprint, across all IBX locations. You can filter these alarms using various parameters. To access the API, you need to specify the Auth bearer token in the header, the account number, the number of records you want returned and the offset to start from. You can specify the groupByIBX attribute to group the alarms by IBX.

To invoke this API, provide the token, account number, page number 1 with 10 records per page and offset 0; as inputs.

The response includes a payload of a set of alarms. This includes fields like IBX, AccountNo, assetId, asset type (for example, UPS), severity as Urgent, status (active or not), ack (true or false) indicating whether Equinix ops team acknowledged the alarm or not, Tagid on which the alarm had triggered, and Time at which the tag got processed. It also informs if the given alarm condition returned to normal or its status turns to false. This set of attributes is repeated for each alarm.

The following screenshot shows the curl request to get all active alarms. 

 

curl -X 

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

-H "content-type: application/json"

-H "authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2' 

 

A list of all active alarms affiliated to your customer account is returned below.

 

{
    "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
}

 

Refer to Get all active alarms under API Reference section for instructions on how to get asset details. You may skip this step if you already know the asset details.