TrueSight API Documentation
OverviewAccountActionsAdministration
Alarms v1Alarms v2BatchingDashboards
DatasetsEventsExtended Metrics
HostgroupsGroupsMetersMetricsProduct
PluginsRelaysSourcesSynchronize Data
Tenants
Terms

GET/v2/alarms

Get all of the Alarms

Example request:

curl https://api.truesight.bmc.com/v2/alarms \
-X GET \
-u <email>:<api-token>

Response:

[
   {
      "id": 1,
      "accountId": 1,
      "catalogName": "default",
      "familyId": 1,
      "hostgroupId": 10,
      "hosts": [
         "database-1",
         "database-2"
      ],
      "isDisabled": false,
      "metric": "CPU",
      "name": "Database High CPU",
      "note": "One of the database hosts CPU is over 90%",
      "notifyClear": true,
      "notifySet": true,
      "perHostNotify": true,
      "projectId": 2,
      "timeoutInterval": 259200000,
      "triggerInterval": 15000,
      "triggerPredicate": {
         "agg": "avg",
         "op": "gt",
         "val": 0.9
      },
      "typeId": 3
   },
   {
      "id": 2,
      "accountId": 1,
      "catalogName": "default",
      "familyId": 1,
      "hostgroupId": 11,
      "hosts": [
         "host-1",
         "host-2"
      ],
      "isDisabled": false,
      "metric": "CPU",
      "name": "Database Host Down",
      "note": "One of the database hosts is not reporting",
      "notifyClear": true,
      "notifySet": true,
      "perHostNotify": true,
      "projectId": 2,
      "timeoutInterval": 259200000,
      "triggerInterval": 60000,
      "triggerPredicate": null,
      "typeId": 4
   },
   {
      "id": 4,
      "accountId": 1,
      "catalogName": "default",
      "familyId": 1,
      "hostgroupId": 11,
      "hosts": [
         "host-1",
         "host-2"
      ],
      "isDisabled": false,
      "metric": "MY_CUSTOM_METRIC",
      "name": "My Service Down",
      "note": "No data is being reported from the service.",
      "notifyClear": true,
      "notifySet": true,
      "perHostNotify": true,
      "projectId": 2,
      "timeoutInterval": 259200000,
      "triggerInterval": 3600000,
      "triggerPredicate": null,
      "typeId": 6
   }
]