ManageEngine® Applications Manager


AddMonitor API

<< Prev

Home

Next >>

AddMonitor API

 

This API allows the user to configure monitors in Applications Manager. The different monitors supported are:

 

Request Parameters


The common parameters involved in the API request are described below:

Field Description        
apikey* The key generated from the Generate API Key option in the 'Admin' tab.
displayname* The display name of the monitor.
subnet The subnet where the server is running. The default value is 225.225.225.0.
pollInterval The interval at which the server needs to be polled. This variable is optional. If no value is mentioned, the default value of 5 minutes will be taken.
addToGroup Denotes whether the monitor should be added as part of a monitor group or not. The value can be either 'True' or 'False'.
groupID The id of the monitor group. This has to provided if 'addToGroup' value is 'True'.
resolvedns The value can be 'True' or 'False'. Do not resolve DNS name when you have multiple system IP addresses configured with single DNS name.

* - mandatory

 

Note:

HTML encoding will be required for parameters with special characters (For example: display name or password).

 

Sample Request

This example helps you add a Windows server to Applications Manager:

 

http://app-windows:9090/AppManager/xml/AddMonitor?apikey=0b0fd47feeff9050d6a45dd7b5bb5791&type=servers&displayname=APM-Windows&host=app-xp4&snmptelnetport=161&os=WindowsXP&mode=SNMP&username=administrator&password=vembu

 

Example output:

 

<AppManager-response uri="/AppManager/xml/AddMonitor">
   <result>
      <response response-code="4000">
         <message>Monitor added successfully.</message>
      </response>
   </result>
</AppManager-response>

 

Sample Error

If the API is not executed correctly, the request will fail and errors will be thrown as shown below.

 

<Apm-response uri="/AppManager/xml/AddMonitor">
   <result>
      <response response-code="4225">
         <message>The Transaction mentioned in the request URL should be yes or no.</message>
      </response>    
    </result>
</Apm-response>

 

Refer this page for a list of common error conditions.

 

 

 

<< Prev

Home

Next >>

Applications Manager REST APIs

AddMonitor API - Application Servers