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

GET/v1/alarms/search

Retrieves alarms by name

URL parameters

alarmName

Example request:

curl https://api.truesight.bmc.com/v1/alarms/search?name=Inbound%20Network%20Traffic%20is%20increasing \
-X GET \
-u <email>:<api-token>

Response:

[
   {
      "id": 10823,
      "name": "Inbound Network Traffic is increasing",
      "triggerPredicate": {
         "agg": "sum",
         "op": "gt",
         "val": 2097152000
      },
      "hostgroupId": 13,
      "metricName": "NETRB",
      "interval": 60,
      "note": "check for DDOS",
      "perHostNotify": false,
      "isDisabled": false,
      "actions": [
         {
            "id": 1693,
            "name": "Email ops"
         }
      ]
   }
]