Return
-
Title
How to get information about the monitored system when querying alarms via REST API? -
Description
When analyzing the alarms queried via REST API, the information about monitored host or database is missing.How to get those details via REST API together with the related alarm. -
Cause
The REST API returns the alarm event object which is an independent object. It has no reference to the monitored system. -
Resolution
To get these information please extend the alarm message. The alarm message is combined in the rule itself and the rule scoped object contains the information about the monitored system.
Please follow these steps:
- First create new rule variables. Find the needed rule on dashboard "Administration | Rules & Notification | Rules" and open it to edit it
- Select the tab "Rules Variables"
- Add an "Expression" to get the host details: Enter the variable name, for example "host" and then the value "scope.monitoredHost.name". Now click on the "Add" button.
- If needed add the agent name too. Add another "Expression" by entering the variable name, for example "agent". Then enter the value "scope.monitoringAgent.name" and click on the "Add" button.
- Both variables should appear now in the list and can be used in the alarm message of each condition. Please be careful that you do not overwrite existing variables. If the variable name "host" or "agent" exist already, choose another name.
- Now these variables can be used in the alarm message. Open the needed condition and add the variable to the "Alarm message", for example: The agent @agent monitoring system @host is affected.