Migrate From Alarms To System Alerts

Migrate your API requests that use a deprecated /alarms endpoint to the new /systemAlerts endpoint.

Old /alarms request:

GET /alarms/v1/smartview/alarms

New /systemAlerts request:

POST /smartview/v2/systemAlerts/search

Get Alarms is a simple GET request that supports a very limited number of input parameters, passed in the query. Retrieve System Alerts is a POST request with input parameters passed in the payload. It supports a larger number of parameters, enabling retrieval of much finer datasets. Alarms data model structure is flat and provides limited information on active alarms only. System Alerts data model provides a more detailed insight into alerts and their processing.

Sample Requests

Sample curl request for /alarms:

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

Sample curl request for /systemAlerts:

curl -X POST 'https://api.equinix.com/smartview/v2/systemAlerts/search' \
-H 'content-type: application/json' \
-H 'authorization: Bearer <token>' \
-d '{
  "filter": {
    "and": [
      {
        "property": "/status",
        "operator": "=",
        "values": [
          "ACTIVE"
        ]
      }
    ]
  },
  "pagination": {
    "offset": 0,
    "limit": 10
  }
}' 

Sample Responses

Sample response from /alarms:

{
  "alarms": [
    {
      "ibx": "DC5",
      "accountNo": "1",
      "assetId": "DC5.UPS-R1",
      "assetType": "UPS",
      "assetClassification": "Electrical",
      "conditionName": "Alarm",
      "status": true,
      "tagId": "DC5.UPS-R1:alarm",
      "timeProcessed": 1550519327497,
      "timeTrigerred": 1546510663707,
      "timeNormalProcessed": 0
    }
  ],
  "groupedAlarms": null,
  "totalCount": 1
}

Sample response from /systemAlerts:

{
  "data": [
    {
      "id": 1931,
      "alertUid": "LD9.Generator-DH09-PG2:gensetavailableinauto#DIGITAL:ALARM",
      "traceUid": "1687495706640/LD9.Generator-DH09-PG2:gensetavailableinauto#DIGITAL:ALARM",
      "assetTagUid": "LD9.Generator-DH09-PG2:gensetavailableinauto",
      "assetTagDisplayName": "Genset Available In Auto",
      "status": "ACTIVE",
      "value": {
        "alertTagValue": "true",
        "alertTagValueDisplayName": "OPEN",
        "activeAlertTagValueDisplayName": "OPEN",
        "currentTagValue": "CLOSED"
      },
      "asset": {
        "ibx": "LD9",
        "assetUid": "LD9.Generator-DH09-PG2",
        "assetType": "Generator",
        "assetClassification": "Electrical",
        "assetRegion": null,
        "assetUnderMaintenance": false
      },
      "configuration": {
        "thresholdValue": "1",
        "thresholdValueDisplayName": "OPEN",
        "unitOfMeasurement": "&",
        "thresholdType": "DIGITAL",
        "conditionName": "ALARM",
        "configurationVersion": "1.0"
      },
      "activeProcessing": {
        "edgeCollectedOn": "2023-06-23T04:48:26.640Z",
        "tagCalculationJobProcessedOn": "2023-06-23T04:48:26.840Z",
        "processingStartOn": "2023-06-23T04:49:01.182223Z",
        "processingEndOn": "2023-06-23T04:49:01.282301Z",
        "publishedOn": "2023-06-23T04:49:01.282301Z"
      },
      "inactiveProcessing": {
        "edgeCollectedOn": null,
        "tagCalculationJobProcessedOn": null,
        "processingStartOn": null,
        "processingEndOn": null,
        "publishedOn": null
      }
    }
  ],
  "pagination": {
    "offset": 20,
    "limit": 10,
    "total": 1
  }
}