|
ManageEngine® Applications Manager 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:
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 |
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. |
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. |
| 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. |
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 |
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. |
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). |
| checkForContent | The keyword for content match. |
| verifyError | The keyword for error verification. |
| errorIfMatch | Enter a keyword which when matches with the content in the URL must be notified of error. Note: The search is case sensitive. Multiple keywords should be put within quotes. Otherwise, it will be treated as 'Any' one of the multiple keywords |
| userName | Provide the User name if the URL requires Form-based authentication. |
| password | Provide password, if the URL requires Form-based authentication. |
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. |
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. |
| domain | Enter the Domain name for which SSL certificate is required to be monitored. |
| isProxyNeeded | Use isProxyNeeded if the server is connected through proxy. Possible values are:
|
| ignoreHostNameError | Specify if you want to Ignore SSL Certificate name mismatch error. Possible Values are:
|
| timeout | Enter the Timeout value in seconds. |
AddMonitor API - Virtualization |
MaintenanceTask API |