TrueSight API Documentation
OverviewAccountActionsAdministration
Alarms v1Alarms v2BatchingDashboards
DatasetsEventsExtended Metrics
GroupsHostgroupsMetersMetricsProduct
PluginsRelaysSourcesSource-TagsSynchronize Data
Tenants
Terms

GET/v2/alarms/:alarmId

Retrieves a single alarm

URL parameters

alarmId

Example request:

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

Response:

{
   "id": 1,
   "accountId": 1,
   "catalogName": "default",
   "familyId": 1,
   "hostgroupId": null,
   "hosts": [
      "database-1",
      "database-2"
   ],
   "isDisabled": false,
   "metric": "CPU",
   "name": "Database 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
}