List Monitor API


ManageEngine Applications Manager provides List Monitor API that allows the user to list details of monitor by the following categories.

  • By monitor Type
  • By monitor ResourceID
  • Listing all the added monitors

This API lists all the monitors of a given type that are configured in Applications Manager for the user corresponding to the API Key. This details displayed includes the Health and Availability of the monitor types, image type, Health outages and Critical/Warning/Clear/UP/Down count for each monitor type.

APIs for ListMonitor

1.  By monitor Type

http://[ Host ]:[ Port ]/AppManager/xml/ListMonitor?apikey=[ API key ]&type=[ TYPE in AM_ManagedObject table ]

2. By particular monitor name

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

3.  Listing all the added monitors

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

4. For JSON Response

http://[ APM Host ]:[ APM Port ]/AppManager/json/ListMonitor?apikey=[ API Key ]&type=[Type]

 

Note:
a) For getting both Esx VirtualMachine and HyperV VirtualMachine , we can simply pass VirtualMachine as type
b) For getting all windows types, pass 'Windows' as type value
c) For all network devices (devices added to APM from OPM) simply pass 'NWD' as value for type.

Request Parameters

FieldDescription        
apikey The key generated from "Generate API" option in the Admin tab.
type

"type=<monitor type>" is used to list all the monitors in a specified monitor type.
<monitor type>  is TYPE in AM_ManagedObject table like Linux, Windows XP, MYSQL-DB-server, Apache-server, UrlMonitor, Tomcat-server, etc.

To get all monitor types we need to pass 'all' as the value for the field type.

resourceid The resourceid of the monitor

 

Example API that is used to get XML of monitors by monitor type:

http://app-windows:9090/AppManager/xml/ListMonitor?apikey=[Api Key]&type=Windows

Example API that is used to get XML of all monitors:

http://app-windows:9090/AppManager/xml/ListMonitor?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&type=all

Example API that is used to get XML of a particular monitor:

http://app-windows:9090/AppManager/xml/ListMonitor?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&resourceid=10000047

Example output:

XML Input:
http://app-windows:9090/AppManager/xml/ListMonitor?apikey=831975d6aace66d71c4f63027&resourceid=1000003
 
Response:
<AppManager-response uri="/AppManager/xml/ListMonitor"><result><response response-code="4000"><Monitor DetailsPageURL="/showresource.do?resourceid=10000035&method=showResourceForResourceID&PRINTER_FRIENDLY=true" HEALTHATTRIBUTEID="1931" ASSOCIATEDGROUPS="Name:Applications Manager;Id:10000029,Name:SubGrp11;Id:10000105" RESOURCENAME="app-windows:9090.csez.zohocorpin.com" Managed="true" HEALTHSEVERITY="1" AVAILABILITYATTRIBUTEID="1930" AVAILABILITYMESSAGE="Resource up. <
>The resource app-windows:9090_Windows 7 is available." AVAILABILITYSEVERITY="5" TYPESHORTNAME="Windows" TYPE="Windows 7" DESCRIPTION="Network Resource" HOSTNAME="app-windows:9090.csez.zohocorpin.com" RESOURCEID="10000035" HEALTHMESSAGE="Health of app-windows:9090_Windows 7 is critical. <br>Root Cause : <br>1. aaa is down <br>2. 111 is down <br>" PORT="-1" DISPLAYNAME="app-windows:9090_Windows 7" RCAPageURL="/jsp/RCA.jsp?resourceid=10000035&attributeid=1931" HEALTHSTATUS="critical" HOSTIP="192.168.26.145" IMAGEPATH="/images/icon_monitors_windows.gif" AVAILABILITYSTATUS="up" LASTALARMTIME="1409221314773"/></response></result></AppManager-response>

 

Note: You can obtain the resourceid of a monitor by executing the ListMonitor API request. The output of this request contains resourceid of the monitor, among other values.

Response Details

Response FieldsDecription
DISPLAYNAME Monitor's Display Name
RESOURCEID Monitor's Resource ID
TYPE Monitor type like Windows, Linux
Health Details

Contains
HEALTHMESSAGE - Which gives the Health Root Cause Message
HEALTHATTRIBUTEID Health Attribute ID 
HEALTHSTATUS - Current health status of the monitor. It can have values clear or warning or critical
HEALTHSEVERITY - Health status in number. Number 1 represents critical, 4 represents warning and 1 represents clear.

Availability Details

Contains
AVAILABILITYMESSAGE - Which gives the Availability Root Cause Message

AVAILABILITYATTRIBUTEID - Availability Attribute ID
AVAILABILITYSTATUS - Current availability status of the monitor. It can have values up or down
AVAILABILITYSEVERITY - Availability status in number. Number 5 represents up and number 1 represents down.

Managed True - the monitor is in Managed state, False - the monitor is in Unmanaged State
RESOURCENAME Monitor's Resource Name
DESCRIPTION Description of the Resource like Network Resource
RCAPageURL URL that links to Root Cause Analysis details
DetailsPageURL URL that links to details page of the monitor
LASTALARMTIME This is the time (Unix epoch in millis) at which last alarm has been generated.
IMAGEPATH This monitor type's icon image path
ASSOCIATEDGROUPS Monitor groups to which this monitor is associated with