ManageEngine® Applications Manager


AddMonitor API - Web Server/Services

<< Prev

Home

Next >>

AddMonitor API - Web Server/Services

 

This section explains how to use the AddMonitor API to add monitors of the category type 'Web Server/Services'. The following monitors are supported:

Apache Server

Syntax:


http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&host=[HOST]&port=[PORT]&serverstatusurl=[SERVERSTATUSURL]&apacheurl=[APACHEURL]

 

Request Parameters:

The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.


Field Description        
type The type of the monitor you want to add. Value should be Apache Server.
host The name of the host where the Apache server is running.
port The port number where the Apache server is running.
apacheauth Denotes whether the Apache server is authenticated. Possible values are true and false.
apacheUserName The user name of the Apache server. This is required only if apacheauth value is true.
apachepassword The password of the Apache server. This is required only if apacheauth value is true.
sslenabled Indicates whether SSL is enabled. The value should be either on or off
serverstatusurl Indicates whether the Apache Server Status url can be modified. The value should be either true or false.
apacheurl The Apache server status url. Example: http://<host-name:portNumber>server-status?auto

Sample Request:


http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=256d041620d0aee9901558b44706dc84
&type=Apache Server&displayname=apmapache&host=shakthiprian&port=8080&serverstatusurl=true&apacheurl=ddss

Top

IIS Server

Syntax:


http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&host=[HOST]&port=[PORT]

 

Request Parameters:

The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.


Field Description        
type The type of the monitor you want to add. Value should be IIS Server.
host The name of the host where the IIS is running.
port The port number where the IIS is running.

Sample Request:


http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=90c166a4646e29315a57eca1d6b88858
&type=IIS Server&displayname=apmiis&host=app-xp2&port=80

Top

 

Nginx Server

Syntax:


http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPALYNAME]&host=[HOST]&port=[PORT]&sslenable=[TRUE/FALSE]&nginxauth=[TRUE/FALSE]&username=[USERNAME]&password=[PASSWORD]&nginxstatusurl=[NGNIX STATUS URL]

 

Request Parameters:

The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.


Field Description        
type The type of the monitor you want to add. Value should be PHP.
host The name of the host where the PHP is running.
port The port number where the PHP is running.
sslenable The path to be used for connection. The default value is /phpstats.php
nginxauth Denotes whether the Nginx server is authenticated. Possible values are true and false.
username The user name of the Nginx server. This is required only if nginxauth value is true.
password The password of the Nginx server. This is required only if nginxauth value is true.
nginxstatusurl Nginx Server Status url. The value should be either true or false. Please do insert /(slash) in prefix for nginxstatusurl as the example given below.

Sample Request:


http://operation-server9:9091/AppManager/xml/AddMonitor?apikey=a7867d64c831a50f8eb5be8bcfebab34&type=Nginx&displayname=apmnginx&host=deepak&port=8080&sslenable=true&nginxauth=true&username=deepak&password=deepak&nginxstatusurl=/nginx_status

 

PHP

Syntax:


http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&host=[HOST]&port=[PORT]&serverpath=[SERVERPATH]

 

Request Parameters:

The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.


Field Description        
type The type of the monitor you want to add. Value should be PHP.
host The name of the host where the PHP is running.
port The port number where the PHP is running.
serverpath The path to be used for connection. The default value is /phpstats.php

Sample Request:


http://operation-server9:9091/AppManager/xml/AddMonitor?apikey=90c166a4646e29315a57eca1d6b88858
&type=PHP&displayname=apmiis&host=myesuraj&port=80&serverpath=/phpstats.php

Top

Real Browser Monitor (RBM)

Syntax:


http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
&displayname=[DISPLAYNAME]&rbmagentID=[RBMAGENTID]&timeout=[TIMEOUT]&scriptname=[SCRIPTNAME]

 

Request Parameters:

The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.


Field Description        
type The type of the monitor you want to add. Value should be RBM.
rbmagentID The ID of the RBM agent.
timeout The timeout value in seconds.
scriptname The name of the web script.

Sample Request:


http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=90c166a4646e29315a57eca1d6b88858
&type=RBM&displayname=RBM_test&rbmagentID=10000000&timeout=15&scriptname=newS

Top

 

URL Monitor

Syntax:


http://[host]:[port]/AppManager/xml/AddMonitor?apikey=[apikey]&type=[type]
&displayname=[displayname]&timeout=[timeout]&url=[httpurl]&urlMethod=[method]
&httpCondition=[condition]&httpValue=[responseCode]&checkForContent=[matchContent]
&pollInterval=[pollInterval]

 

Request Parameters:

The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.


Field Description        
type The type of the monitor you want to add. Value should be UrlMonitor.
displayname Name of the monitor to be created.
timeout The timeout value in seconds.
url The HTTP / HTTPS URL address that you want to monitor.
urlMethod This method specifies how to send form-data. Value should be G / P for Get and Post respectively.
httpCondition Error Response Code condition. Value should be LT / GT / EQ / NE / LE / GE (default GT).
httpValue The response code number based on which the monitor will be shown as up or down (default 200).
requestParams Specify the request parameters(eg., username, password) with %0A as the delimiter.
checkForContent Keyword for content match.
verifyError Keyword for error verification.

Sample Request:


http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=90c166a4646e29315a57eca1d6b88858&type=UrlMonitor&displayname=appmanager&timeout=60&url=http://appmanager.com&urlMethod=G&httpCondition=EQ&httpValue=200&requestParams=username=appAdmin%0Apassword=adminPass%0Arole=admin&checkForContent=Applications&verifyError=Exception

Top

 

Web Server

Syntax:


http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&host=[HOST]&port=[PORT]

 

Request Parameters:

The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.


Field Description        
type The type of the monitor you want to add. Value should be Web Server.
host The name of the host where the web server is running.
port The port number where the web server is running.

Sample Request:


http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=90c166a4646e29315a57eca1d6b88858
&type=Web Server&displayname=apmweb&host=app-xp2&port=80

Top

 

SSL Certificate Monitor

Syntax:


http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=SSLCertificateMonitor&displayname=[displayName]&domain=[domain]&port=[port]

 

Request Parameters:

The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.


Field Description        
type The type of the monitor you want to add. Value should be SSLCertificateMonitor.
host The name of the host where the SSL Certificate Monitor is running.
port The port number where the SSL Certificate Monitor is running.

Sample Request:


http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194&type=SSLCertificateMonitor&displayname=SSLCertificateMonitor&domain=www.zoho.com&port=443&timeout=60

Top


Nginx Monitor

Syntax:


http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Nginx&displayname=[displayName]&host=[Host Name]&port=[port]&username=[user Name]&password=[Password]&nginxstatusurl=[Nginx Status URL]

 

Request Parameters:

The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.


Field Description        
type The type of the monitor you want to add. Value should be Nginx.
host The name of the host where the Nginx server is running.
port The port number where the Nginx server is running.

Sample Request:


http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=849c51ce33436587873a08d69d5447fc&type=Nginx&displayname=nginix&host=deepak-1470&port=1888&username=deepak&password=deepak&nginxstatusurl=/nginx_status

Top


<< Prev

Home

Next >>

AddMonitor API - Virtualization

MaintenanceTask API