ManageEngine® Applications Manager


Chapter 10.1 List Monitor API

<< Prev

Home

Next >>

 

List Monitor API

 

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

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

 

Request Parameters

Field Description        
API Key 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 SHORTNAME in AM_ManagedResourceType table like Linux, Windows , MS SQL, Apache, Service Monitoring, Url Sequence, Tomcat etc.
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=[ Type ]

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

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

Example API that is used to get XML of a particular monitors.

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

Example output:

Monitor Details:

DISPLAYNAME Monitor's Display Name
RESOURCE ID Monitor's Resource ID
TYPE Monitor type like Windows, Linux
Health Details Contains HEALTHMESSAGE that gives the Health Root Cause Message, Health Attribute ID, HEALTHSEVERITY - (5/4/1) - Clear/Warning/Crirical , STATUS - Clear/Warning/Critical
Availability Details Contains AVAILABILITYMESSAGE that gives the Availability Root Cause Message, Availability Attribute ID, AVAILABILITYSEVERITY - Up/Down (5/1), STATUS - UP/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



<AppManager-response uri="/AppManager/xml/ListMonitor">
    <result>
        <response response-code="4000">
       <Monitor DISPLAYNAME="myes" RESOURCEID="10000025" TYPE="Windows XP" RESOURCENAME="myes" DESCRIPTION="Network Resource" Managed="true" DetailsPageURL="showresource.do?resourceid=10000025&method=showResourceForResourceID&PRINTER_FRIENDLY=true" RCAPageURL="jsp/RCA.jsp?resourceid=10000025&attributeid=1651" HEALTHATTRIBUTEID="1651" HEALTHMESSAGE="Health of myes is clear. <br>Root Cause : <br>1. myes is up<br>" HEALTHSEVERITY="5" HEALTHSTATUS="clear" AVAILABILITYATTRIBUTEID="1650" AVAILABILITYMESSAGE="Resource up. <br>The resource myesuraj.zohocorpin.com is available." AVAILABILITYSEVERITY="5" AVAILABILITYSTATUS="up"/>
           </response>
</result>
</AppManager-response>


 

 

<< Prev

Home

Next >>

REST APIs

List Server