ManageEngine® Applications Manager


Chapter 10.3 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.

 

APIs for ListAlarms.

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

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=[ N ]



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=[ 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.
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.

 

 

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
SEVERITY Clear/Warning/Critical - (5/4/1)
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'

 

 

<AppManager-response uri="/AppManager/xml/ListAlarms">
    <result>
        <response response-code="4000">
            <Alarm RESOURCEID="10000112" DISPLAYNAME="Linux1" TYPE="Linux" TYPEDISPLAYNAME="Linux" SEVERITY="1" STATUS="critical " MESSAGE="Health of Linux1 is critical. <br>Root Cause : <br>1. Total Disk Utilization(%) 54.0 > 52.0 (Anomaly).<br><br>" ATTRIBUTEID="701" MODTIME="1263361294086"/>
               </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 >>

ListServer API

Manage API