ManageEngine® Applications Manager Search API |
||
This API will fetch the List of Monitors / Monitor Groups that matches the query string. Also the search will be with in the list of monitors assigned to the user.
API for XML Response:
http://[ APM Host ]:[ APM Port ]/AppManager/xml/Search?apikey=[ API Key ]&query='pavan'
API for JSON Response:
http://[ APM Host ]:[ APM Port ]/AppManager/json/Search?apikey=[ API Key ]&query='pavan'
Request Parameters:
Field | Description |
query | This value specifies the string that has to be searched in the monitors list associated to an user. |
Response Details:
Field | Description |
Type | This represents the type of the element got in search results |
HealthStatus | This is health status of the search element |
AvailabilityMessage | This is the availability message of the search element |
DisplayName | This is the displayname of the search element |
ManagedServer | This is the managed server name in which the monitor or group is added.It will have 'NA' as value for professional edition |
AvailabilityStatus | This is availability status of the search element |
SubGroup | This is category to which the elements belongs to. |
ResourceId | This is the resource id of the search element. |
HealthMessage | This is the health message of the search element |
HealthSeverity | This is the health severity of the search element |
ImagePath | This is monitor type/ monitor group image path |
AvailabilitySeverity | This is the availability severity of the search element |
DetailsPageURL | This is details page of the search element. |
<AppManager-response uri="/AppManager/xml/Search"> <result> <response response-code="4000"> <Monitor Type="EC2Instance" HealthStatus="clear" AvailabilityMessage="Resource down. <br>The resource APM_10 is not available." DisplayName="APM_10" ManagedServer="Admin Server" AvailabilityStatus="down" SubGroup="EC2Instance" ResourceId="10000406" HealthMessage="Cleared by User" HealthSeverity="5" ImagePath="/images/icon_monitor_ec2_ins.gif" AvailabilitySeverity="1" DetailsPageURL="/showresource.do?resourceid=10000406&method=showResourceForResourceID&PRINTER_FRIENDLY=true"/> <Monitor Type="EC2Instance" HealthStatus="clear" AvailabilityMessage="Resource up. <br>The resource Apm-Insight Beta version is available." DisplayName="Apm-Insight Beta version" ManagedServer="Admin Server" AvailabilityStatus="up" SubGroup="EC2Instance" ResourceId="10000407" HealthMessage="Health of Apm-Insight Beta version is clear. <br>Root Cause : <br>1. Apm-Insight Beta version is up<br>2. vol-68491f01 --> <br>" HealthSeverity="5" ImagePath="/images/icon_monitor_ec2_ins.gif" AvailabilitySeverity="5" DetailsPageURL="/showresource.do?resourceid=10000407&method=showResourceForResourceID&PRINTER_FRIENDLY=true"/> <Monitor Type="APM-Insight-Instance" HealthStatus="critical" AvailabilityMessage="Resource down. <br>The resource hemachand-0591:8080 is not available." DisplayName="hemachand-0591:8080" ManagedServer="Admin Server" AvailabilityStatus="down" SubGroup="APM-Insight-Instance" ResourceId="10007308" HealthMessage="Resource hemachand-0591:8080 is down. <br>Health is critical as the resource is not available" HealthSeverity="1" ImagePath="/apminsight/images/apminsight-icon.gif" AvailabilitySeverity="1" DetailsPageURL="/showresource.do?resourceid=10007308&method=showResourceForResourceID&PRINTER_FRIENDLY=true"/> <Monitor Type="Windows XP" HealthStatus="clear" AvailabilityMessage="Resource up. <br>The resource APM-Windows is available." DisplayName="APM-Windows" ManagedServer="Admin Server" AvailabilityStatus="up" SubGroup="Windows" ResourceId="10001267" HealthMessage="Health of APM-Windows is clear. <br>Root Cause : <br>1. Data Collection Successful<br>2. APM-Windows is up<br>" HealthSeverity="5" ImagePath="/images/icon_monitors_windows.gif" AvailabilitySeverity="5" DetailsPageURL="/showresource.do?resourceid=10001267&method=showResourceForResourceID&PRINTER_FRIENDLY=true"/> </response> </result> </AppManager-response> |
JSON Input http://apm-prod1:9090/AppManager/json/Search?apikey=c4e547c2330e2eb92d3e7af2262da9e9&query='apm-prod1' JSON Response {"response-code":"4000","response":{"uri":"/AppManager/json/Search","result":[{"Type":"UrlMonitor","HealthStatus":"critical","AvailabilityMessage":"Resource down. <br>The resource AppManager Home Page is not available.Connection Timed Out. Increase the time out level:ResponseCode -200<br>-->>","DisplayName":"AppManager Home Page","ManagedServer":"Admin Server","AvailabilityStatus":"down","SubGroup":"UrlMonitor","ResourceId":"20000043","HealthMessage":"Health of AppManager Home Page is critical. <br>Root Cause : <br>1. AppManager Home Page is down<br>","HealthSeverity":"1","ImagePath":"/images/icon_monitors_urlmonitor.gif","AvailabilitySeverity":"1","DetailsPageURL":"/showresource.do?resourceid=20000043&method=showResourceForResourceID&PRINTER_FRIENDLY=true"},{"Type":"Apache-server","HealthStatus":"clear","AvailabilityMessage":"Resource up. <br>The resource apm-prod1_Apache Server_9090 is available.","DisplayName":"apm-prod1_Apache Server_9090","ManagedServer":"Admin Server","AvailabilityStatus":"up","SubGroup":"Apache-server","ResourceId":"20000041","HealthMessage":"Health of apm-prod1_Apache Server_9090 is clear. <br>Root Cause : <br>1. apm-prod1_Apache Server_9090 is up<br>2. Response TimeĀ 16 <= 1500 ms (threshold).<br>","HealthSeverity":"5","ImagePath":"/images/icon_monitors_apache.gif","AvailabilitySeverity":"5","DetailsPageURL":"/showresource.do?resourceid=20000041&method=showResourceForResourceID&PRINTER_FRIENDLY=true"},{"Type":"Windows Vista","HealthStatus":"clear","AvailabilityMessage":"Resource up. <br>The resource apm-prod1_Windows Vista is available.","DisplayName":"apm-prod1_Windows Vista","ManagedServer":"Admin Server","AvailabilityStatus":"up","SubGroup":"Windows","ResourceId":"20000039","HealthMessage":"Health of apm-prod1_Windows Vista is clear. <br>Root Cause : <br>1. Data Collection Successful<br>2. apm-prod1_Windows Vista is up<br>","HealthSeverity":"5","ImagePath":"/images/icon_monitors_windows.gif","AvailabilitySeverity":"5","DetailsPageURL":"/showresource.do?resourceid=20000039&method=showResourceForResourceID&PRINTER_FRIENDLY=true"}]}} |
List User Details API |
Show Polled Data API |