ManageEngine® Applications Manager


List Alarms API

<< Prev

Home

Next >>

List Alarms API

 

ManageEngine Applications Manager provides List Alarms API that allows the user to list the information regarding recent alarms in an XML format. The alarm APIs are listed as follows.

This API will list all alarms of the monitors configured in the Applications Manager for the user corresponding to the API Key. This details will include the Health and Availability of the monitor types, type image, Health outages, Critical/Warning/Clear/UP/Down count for each and every monitor type.

 

APIs for ListAlarms.

http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&type=all

http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&type=critical

http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&type=warning

http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&type=clear

http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&time=[ Time ]

http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&resourceid=[ resourceid ]

http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&type=[ TYPE ]

http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&topN=[ XYZ ]

http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey= [ API key ]&groupName=Applications Manager

 

 

 

 

Note:

a) For getting all the alarms we need to pass 'type=all' .... its mandatory.

b) For combination of severity of alarms, ex: we can pass 'critical,warning' as a value for type to get both critcal and warning.


Request Parameters

Field Description        
API Key The key generated from "Generate API" option in the Admin tab.
resourceid "resourceid=[ resourceid of monitor ]" is used to list the alarms of particular monitor.
Type
"type=all" is used to list all alarms.
"type=critical" is used to list all the critical alarms.
"type=warning" is used to list all the warning alarms.
"type=clear" is used to list all the clear alarms.
"type=[ Monitor type ]" is used to list alarms by monitor type where <monitor type>  is TYPE in AM_ManagedObject table like Linux, Windows XP, MYSQL-DB-server, Apache-server, UrlMonitor, Tomcat-server, etc.
Top N "topN=[ N ]" is used to list the top N alarms.
Time "time=[ Time ]" is used to list the alarms generated after the specified time.
<Time> is repesented in milli second.

 

Extra Attributes:

AVAILABILITYSEVERITY This is the monitor availability severity (1 - critical, 5- clear)
HEALTHSEVERITY (previously known as SEVERITY) This is the monitor severity for health (1-critical, 4-warning & 5- clear)
TECHNICIAN This value specifies the technician who has acknowleged/ picked up the Alarm generated for this monitor.
ANNOTATION This value is the annotation added regarding the alarm generated for this monitor.
DetailsPageURL This value is the link to the details page of the monitor for which the alarm is generated.

API for XML Response :
http://[ APM Host ]:[ APM Port ]/AppManager/xml/ListAlarms?apikey=[ API Key ]&type=all

 

API for JSON Response :
http://[ APM Host ]:[ APM Port ]/AppManager/json/ListAlarms?apikey=[ API Key ]&type=''critical,clear'

 

Example API that is used to get XML of all recent alarms details.

http://app-windows:9090/AppManager/xml/ListAlarms?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a

 

Example output:

 

Alarm Details

 

DISPLAYNAME Display Name of the Monitor like Linux-1
RESOURCEID Resource ID of the Monitor
HEALTHSEVERITY This is the monitor severity for health (1-critical, 4-warning & 5- clear)
MESSAGE Alarm message like 'Resource is down. Health is critical as the resource is not available'
ATTRIBUTE ID Attribute ID of health of monitor
MODTIME Time when the Alarm was generated (ms)
STATUS Clear/Warning/Critical - status of the alarm
TYPE Type of the Monitor like Linux
TYPEDISPLAYNAME Display Name of the Type like 'Linux'
AVAILABILITYSEVERITY This is the monitor availability severity (1 - critical, 5- clear)
TECHNICIAN This value specifies the technician who has acknowleged/ picked up the Alarm generated for this monitor.
ANNOTATION This value is the annotation added regarding the alarm generated for this monitor.
DetailsPageURL This value is the link to the details page of the monitor for which the alarm is generated.

 

 

<AppManager-response uri="/AppManager/xml/ListAlarms">
<result>
<response response-code="4000">
<Alarm DISPLAYNAME="DB2" MODTIME="1333012233887" AVAILABILITYSEVERITY="5" ATTRIBUTEID="2601" TECHNICIAN="None"
STATUS="warning" MESSAGE="Health of DB2 is warning. <br>Root Cause : <br>1. Connection Time 1504 > 1500 ms (threshold).<br>"
ANNOTATION="YES" RESOURCEID="10001307" TYPE="DB2-server" DetailsPageURL="/showresource.do?resourceid=10001307&method=showResourceForResourceID&PRINTER_FRIENDLY=true"
TYPEDISPLAYNAME="DB2" SHORTMESSAGE="Health is Warning" HEALTHSEVERITY="4" />
</response>
</result>
</AppManager-response>

Example API that is used to get XML of all recent alarms details which are generated after a particular time.

http://app-windows:9090/AppManager/xml/ListAlarms?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&time=1248868798412

 

 

<< Prev

Home

Next >>

ListActions API

ListDashboards API