AddMonitor APIs - 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:
Supported HTTP methods: POST
Allowed roles: Administrator
Apache Server
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME] &host=[HOST]&port=[PORT]&serverstatusurl=[SERVERSTATUSURL]&apacheurl=[APACHEURL]
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer to 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
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Apache Server&displayname=apmapache&host=apachehost&port=8080&serverstatusurl=true&apacheurl=ddss
Apache Solr
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&SSL=[TRUE/FALSE]https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&SSL=[TRUE/FALSE]&UserName=[USERNAME]&Password=[PASSWORD]
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer to the list of common request parameters.
| Field | Description |
|---|
| type | The type of the database you want to add. Value should be Apache Solr |
| display name | Display name of the Apache Solr monitor |
| host | The name of the host in which Apache Solr server is running. |
| port | The port number where Apache Solr server is running. |
| SSL | Denotes if SSL is enabled or not. Value should be either true or false |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=ApacheSolr&displayname=SolrInstance&host=app-xp2&port=8993&ssl=falsehttps://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=ApacheSolr&displayname=SolrInstance&host=localhost&port=7574&ssl=false&UserName=admin&Password=appman
IIS Server
Syntax
For Applications Manager versions till 15110:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&sslconfigured=[True/False]
For Applications Manager version 15120 onwards:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&sslenabled=[True/False]&donotresolvens=[True/False]&responseheadercheck=[True/False]&mode=[wmi/winrm]&Protocol=[http/https]&Advanced=[Yes/False]&WinrmPort=[WINRMPORT]&urlRetry=[True/False]&wmiRetry=[True/False]&responseCodeCheck=[True/False]
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer to 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. |
| username | Username of the IIS server. |
| password | Password of the IIS server. |
sslenabled
sslconfigured | Indicates whether SSL is configured in the IIS server (True/False). Use sslenabled for APM build version 15120 and above and sslconfigured for APM build version 15110 and below. |
| donotresolvens | Indicates whether DNS needs to be resolved in the IIS server or not (True/False). |
| mode | Mode of monitoring to be used.(wmi/winrm) |
| Protocol | Protocol with which the WinRM mode of data collection happens.(http/https) |
| Advanced | Need to set as 'Yes' to use custom port for WinRM (Yes/False). |
| WinrmPort | Value of the custom port used for WinRM. |
| urlRetry | Indicates whether basic URL check needs to be re-tried if it fails during data collection (True/False). |
| wmiRetry | Indicates whether basic WMI connectivity needs to be re-tried if it fails during data collection (True/False). |
| responseCodeCheck | Specifies whether to validate the response code from the URL response (True/False). |
| responseheadercheck | Indicates whether the IIS keyword needs to be checked in the response header (True/False). |
Sample Request
For Applications Manager versions till 15110:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=IIS Server&displayname=apmiis&host=app-xp2&port=80&sslconfigured=True
For Applications Manager versions 15120 onwards:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=IIS-server&displayname=apmiis&host=apm-nps&port=80&username=apmnps\administrator&password=Server@123&sslenabled=False&donotresolvens=False&responseheadercheck=True&mode=winrm&Protocol=http&Advanced=Yes&WinrmPort=5985&urlRetry=True&wmiRetry=True&responseCodeCheck=True
Nginx Server
Syntax:
https://[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]
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer to 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. |
| sslenabled | Denotes if SSL is enabled or not. Value should be either true or false. |
| 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. Please insert a /(slash) as a prefix for nginxstatusurl, as shown in the example below. |
Sample Request:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Nginx&displayname=apmnginx&host=deepak&port=8080&sslenable=true&nginxauth=true&username=admin&password=appman&nginxstatusurl=/nginx_status
PHP
Syntax:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&sslenabled=[TRUE/FALSE]&serverpath=[SERVERPATH]
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer to 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. |
| sslenabled | Indicates whether SSL is enabled. The value should be either true or false. |
| serverpath | The path to be used for connection. The default value is /phpstats.php. |
Sample Request:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=PHP&displayname=apmphp&host=myesuraj&port=80&sslenabled=false&serverpath=/phpstats.php
URL Monitor
Syntax:
https://[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]®ex=true&casesensitive=true
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer to 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. |
| httpVersion | Specifies the HTTP Protocol version supported by the URL. Values can be Auto/H2/H1.1 (default: H1.1) |
| httpCondition | The response code condition for which the error should be notified. 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 content to be searched while performing the content check in the URL response. |
| verifyError | Indicates whether monitoring is to be automatically performed whenever it detects an error, i.e. when an error is detected, the monitor will immediately be scheduled to run again once. |
| 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 | The username of the URL if it requires Form-based authentication. |
| password | The username of the URL if it requires Form-based authentication. |
| payload | Specify the payload type for the POST form submission method using the following options: (F)ORM, (T)ext, (X)ML, (J)SON. Please use the corresponding values: F for Form, T for Text, X for XML, and J for JSON. |
| regex | Specify if the content for content check contains a regular expression. The value of this field should be 'true', if you want to enable it. |
| casesensitive | Specify if you want to do a case sensitive keyword search. The value of this field should be 'true', if you want to enable it. |
| userAgent | Set the User Agent for monitoring the URL. (Values can be added like Mozilla/5.0 (compatible; MSIE 9.0; Windows Phone OS 7.5; Trident/5.0; IEMobile/9.0)) |
| sslVersion | Specify the version of SSL configured for the URL. The values can one of the following values: SSLv3, TLSv1, TLSv1.1, TLSv1.2 or TLSv1.3. Default value will be Auto. (NON-MANDATORY PARAMETER) |
Sample Request:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=UrlMonitor&displayname=appmanager&timeout=60&url=https://manageengine.com/apm&urlMethod=G&httpCondition=EQ&httpValue=200&requestParams=username=admin&password=appman&role=admin&checkForContent=Applications&verifyError=Exception&errorIfMatch=quit®ex=true&casesensitive=true
Web Server
Syntax:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&host=[HOST]&port=[PORT]
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer to 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:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Web Server&displayname=apmweb&host=app-xp2&port=80
SSL/TLS Certificate Monitor
Syntax:
https://[HOST]:[PORT]/AppManager/xml/AddMonitorapikey=279889b29ba9d47f6b44334f78526f62&type=SSLCertificateMonitor&displayname=[DISPLAYNAME]&domain=[DOMAIN]&port=[PORT]&monitorLeafCertOnly=[IGNORE INVALID CERTIFICATE]&trustCheck=[TRUSTCHECK]&blacklistCheck=[BLACKLISTCHECK]&ignoreSelfSignedCertificate=[IGNORE SELF CERTIFICATE]&timeout=[TIMEOUT]
Request Parameters
The parameters involved in the API request are described below. Also, refer to the list of common request parameters.
| Field | Description |
|---|
| type | The type of the monitor you want to add. Value should be SSLCertificateMonitor. |
| port | The port in which the server is running. |
| protocol | The version of the SSL/TLS protocol. The value should be Auto / SSLv3 / TLSv1 / TLSv1.1 / TLSv1.2 / TLSv1.3 |
| domain | Enter the Domain name for which SSL/TLS certificate is required to be monitored. |
| isProxyNeeded | Use isProxyNeeded if the server is connected through proxy. Possible values are: - isProxyNeeded=true
- isProxyNeeded=false
|
| ignoreHostNameError | Specify if you want to Ignore Certificate name mismatch error. Possible Values are: - ignoreHostNameError=true
- ignoreHostNameError=false
|
| monitorLeafCertOnly | Option to ignore invalid root and intermediate certificate. If the value is not passed, then it is assumed to be true. (true or false) |
| trustCheck | Specify if you want to perform a trust check on the SSL/TLS certificate. Possible Values are: True/False. |
| blacklistCheck | Option to verify if the SSL/TLS domain uses any certificates from blacklisted Certificate Authorities (CAs). Possible Values are: True/False. |
| ignoreSelfSignedCertificate | Specify if you want to Ignore Self Signed Certificate. Possible Values are: True/False. |
| timeout | Enter the Timeout value in seconds. |
Sample Request:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=SSLCertificateMonitor&displayname=SSLCertificateMonitor&domain=www.zoho.com&port=443&timeout=60&monitorLeafCertOnly=false&protocol=TLSv1.2
Elasticsearch Monitor
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE] &displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&ssl=[true/false]&DiscoverAllNodes=[Yes/No]&authEnabled=[true/false]&username=[USERNAME]&password=[PASSWORD]
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer to the list of common request parameters.
| Field | Description |
|---|
| apikey | The key generated from the Generate API Key option in the 'Settings' tab. |
| type | The type of the monitor you want to add. Value should be ElasticSearchCluster. |
| displayname | The display name of the Elasticsearch monitor. |
| host | The name of the host in which Elasticsearch server is running. |
| port | The port number where Elasticsearch server is running. |
| ssl | Specfies if SSL is enabled or not. Value can be either true or false. |
| DiscoverAllNodes | Specifies if you want to discover nodes in Elasticsearch cluster. (Yes/No) |
| authEnabled | Indicates whether user authentication is enabled for the Elasticsearch cluster. (True/False) |
| username | Username of the Elasticsearch cluster. |
| password | Password of the Elasticsearch cluster. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=ElasticSearchCluster&displayname=localhost&host=localhost&port=9200&ssl=false&authEnabled=true&username=admin&password=appman
To discover nodes:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee& DiscoverAllNodes=Yes&type=ElasticSearchCluster&host=104.49.30.30&port=9200&ssl=false&displayname=test&authEnabled=true&username=admin&password=appman
HAProxy Monitor
Syntax:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=HAProxy&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&SSL=[TRUE/FALSE]&authEnabled=true&UserName=admin&Password=appman&haproxystatusurl=/stats
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer to the list of common request parameters.
| Field | Description |
|---|
| apikey | The key generated from the Generate API Key option in the 'Settings' tab. |
| type | The type of the monitor you want to add. Value should be HAProxy. |
| displayname | The display name of the HAProxy monitor. |
| host | The name of the host in which the HAProxy server is running. |
| port | The port number where the HAProxy server is running. |
| ssl | Specifies if SSL is enabled or not. Value can be either true or false. |
| authEnabled | Specifies if authentication is enabled for the HAProxy server. Value can be either true or false. |
| UserName | Username of the HAProxy server. |
| Password | Password of the HAProxy server. |
| haproxystatusurl | URI where the stats of the HAProxy are displayed. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=HAProxy&displayname=HAProxy Monitor&host=apmweb&port=7070&SSL=true&authEnabled=true&UserName=admin&Password=appman&haproxystatusurl=/stats
IBM HTTP Server
Syntax:
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=IBMHTTPServer&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&sslenabled=[true/false]&authEnabled=[true/false]&UserName=[USERNAME]&Password=[PASSWORD]&serverstatusurl=[true/false]&IbmHttpServerUrl=[Server Status URL]&timeout=[Connection Timeout]
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer to the list of common request parameters.
| Field | Description |
|---|
| host | The name or Ip address of the host where the IBM HTTP server is running. |
| port | The Running Port of the IBM HTTP server. |
| sslenabled | Indicates whether SSL is enabled. |
| authEnabled | Indicates whether user authentication is enabled for the server. |
| UserName | Username of the IBM HTTP server. |
| Password | Password of the IBM HTTP server. |
| serverstatusurl | This option must be enabled if there is a need to modify the Server Status URL to connect to the IBM HTTP Server. |
| IbmHttpServerUrl | The default value of the server status url is /server-status?auto. |
| timeout | The timeout value in seconds. |
Sample Request
http://apm-prod-server:9090/AppManager/xml/AddMonitor?apikey=aaaaaaaaaaabbbbbbbbbbbcccccccccddddddeeeeeeee&type=IBMHTTPServer&displayname=apmservice&host=xyz-abc-http&port=8080&authEnabled=false&sslenabled=false&UserName=&Password=&serverstatusurl=false&IbmHttpServerUrl=&timeout=40
Oracle HTTP Server
Syntax:
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=OracleHTTPServer&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&sslenabled=[true/false]&authEnabled=[true/false]&UserName=[USERNAME]&Password=[PASSWORD]&serverstatusurl=[true/false]&OracleHttpServerUrl=[Server Status URL]&timeout=[Connection Timeout]
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer to the list of common request parameters.
| Field | Description |
|---|
| host | The name or IP address of the host where the Oracle HTTP server is running. |
| port | The running port of the Oracle HTTP server. |
| sslenabled | Indicates whether SSL is enabled. |
| authEnabled | Indicates whether user authentication is enabled for the server. |
| UserName | Username of the Oracle HTTP server. |
| Password | Password of the Oracle HTTP server. |
| serverstatusurl | This option must be enabled if there is a need to modify the Server Status URL to connect to the Oracle HTTP Server. |
| OracleHttpServerUrl | The default value of the server status url is /server-status?auto. |
| timeout | The timeout value in seconds. |
Sample Request
http://localhost:9090/AppManager/xml/AddMonitor?apikey=8e771a0dfee2b3ab6eed5431b6231cf2&type=OracleHTTPServer&displayname=Testing&host=def-tqr-http&port=7777&authEnabled=false&sslenabled=false&UserName=&Password=&serverstatusurl=false&OracleHttpServerUrl=&timeout=40
Web Services
Syntax:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Web Service&displayname=[DISPLAYNAME]&timeout=[TIMEOUT]&WSDLUrl=[WSDLURL]&endPointUrl=[ENDPOINTURL]&resFulWebservice=[true/false]&haid=[Monitor GroupId]&username=[USERNAME]&password=[PASSWORD]&customHeaders=[Custom Header]&authToken=[Authentication Token]
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer to the list of common request parameters.
| Field | Description |
|---|
| type | The type of the monitor you want to add. Value should be Web Service. |
| WSDLUrl | The WSDL URL of the document that describes the web services operations, input and output messages, and protocols. |
| endPointUrl | The endpoint address URL that defines the location of the web service and the associated parameters required to invoke a specific operation. |
| resFulWebservice (optional) | Set this value to true to enable REST-compliant Web services. |
| haid (optional) | The Monitor Group ID. |
| username (optional) | The usernamerequired to invoke theweb service. |
| password (optional) | The passwordrequired to invoke theweb service. |
| customHeaders (optional) | Specify the headers to establish a connection with the API server. You can use our pre-defined headers or create your own custom headers to invoke operations. For specifying multiple headers, use the separator # and : to separate individual keys and values. |
| authToken (optional) | Specify the Authentication Token for extracting a specific value from the SOAP Response for sequential execution. The token is of the format <OperationName>_SEP_<TagToBeExtracted>. |
| timeout | The amount of time spent by Applications Manager to establish a connection with the server hosting the API service (in seconds). |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaaaaaaabbbbbbbbbbbcccccccccddddddeeeeeeee&type=Web Service&displayname=apmservice&WSDLUrl=https://www.manageengine.com/products/applications_manager/&timeout=30&resFulWebservice=true&haid=10001&username=admin&password=appman&customHeaders=test&authToken=authtoken
Nginx Plus
Syntax:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=NginxPlus&displayname=[DisplayName]&host=[HostName]&port=[PortNo]&ssl=[true/false]&UserName=[UserName]&Password=[password]
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer to the list of common request parameters.
| Field | Description |
|---|
| type | The type of the Service you want to add. Value should be NginxPlus. |
| host | The name of the host in which Nginx Plus is running. |
| ssl | Whether SSL is enabled. Value should be true or false. |
| port | The port number where Nginx Plus is running. |
| username (Optional) | The name of the user who has permission to access the Nginx Plus. |
| password (Optional) | The password of the user who has permission to access the Nginx Plus. |
Sample Request:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=NginxPlus&displayname=FromAPI&host=demo.nginx.com&port=443&ssl=true&UserName=admin&Password=appman
ME ServiceDesk Plus
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&hostname=[HOST]&port=[PORT]&ssl=[TRUE/FALSE]&restapiKey=[RestAPIKey]&MonitorPGSQLDB=[MonitorPGSQLDB]&dbtype=[DBType]&DBHost=[DatabaseHost]&DBName=[DataBaseName]&DBPort=[DataBasePort]&DBUserName=[DataBaseUserName]&DBPassword=[DBPassword]&namedInstance=[IsNameInstance]&instance=[instance]
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer to the list of common request parameters.
| Field | Description |
|---|
| Hostname | The name or Ip address of the host where Servicedesk-Plus / SDP MSP is running. |
| Port | The Running Port of Servicedesk-Plus / SDP MSP. |
| SSL If Enabled | Specifies if SSL enabled for Servicedesk-Plus / SDP MSP. |
| restapiKey | To generate a new API key in ServiceDesk Plus, follow the steps given below: - Log in to ServiceDesk Plus.
- Go to the Personalize tab available in the top pane.
- Click API key Generation.You can either select the Never Expire option or specify the date of expiry:
- If you select the Never Expire option, the key will be used in Applications Manager, until you generate a new key.
- If you have set a date of expiry, you must manually update the new key in APM after that set time period for data collection to happen.
- Click Generate.
- Copy the API Key generated to use it in Applications Manager.
|
| MonitorPGSQLDB | Specify if you wish to monitor PGSQL Database with Yes/No. Displaying the respective tab in UI depends on this value. (Case Sensitive) |
| DBType | The Database Type. Values can be pgsql or mssql. (Case Sensitive) |
| DBName, DBPort, DBUserName and DBPassword | PostgresSQL database credentials. |
| SSLEnabled | True if the SSL is enabled. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=SDPMonitor&displayname=apm_sdp&hostname=apm-host&port=8081&ssl=false&restapiKey=aaaabbbb-cccc-dddd-eeee-ffffgggghhhh&MonitorPGSQLDB=Yes&dbtype=pgsql&DBHost=pgsqlhost&DBName=pgsqldb&DBPort=8443&DBUserName=admin&DBPassword=appman&namedInstance=sdpNamedInstance&instance=sdpInstance
ME OpManager
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=OPMMonitor&hostname=[HOST]&port=[PORT]&authEnabled=[true/false]&username=[USERNAME]&password=[PASSWORD]&displayname=[DISPLAYNAME]&JNDIPath=[JNDIPATH]&MonitorPGSQLDB=[Yes/No]&dbtype=[DBType]&DBHost=[DatabaseHost]&DBName=[DataBaseName]&DBPort=[DataBasePort]&DBUserName=[DataBaseUserName]&DBPassword=[DBPassword]&namedInstance=[IsNameInstance]&instance=[instance]&SSLEnabled=[SSLEnabled]
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.
| Field | Description |
|---|
| Hostname | The name or Ip address of the host where ME OPManager is running. |
| Port | The running port of ME OPManager. |
| authEnabled | Specifies if authentication is enabled for ME OPManager. |
| username and password | Credential of the user. |
| JNDIPath | JNDIPATH for installation of OpManager |
| MonitorPGSQLDB | Specify if you wish to monitor PGSQL Database with Yes/No. Displaying the respective tab in UI depends on this value. (Case Sensitive) |
| DBType | The Database Type. Values can be pgsql or mssql. (Case Sensitive) |
| DBName, DBPort, DBUserName and DBPassword | PostgresSQL database credentials. |
| SSLEnabled | True if the SSL is enabled. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=OPMMonitor&hostname=172.21.151.93&port=1998&authEnabled=false&username=admin&password=appman&displayname=testOPM&JNDIPath=/jmxrmi&MonitorPGSQLDB=Yes&dbtype=pgsql&DBHost=172.21.151.93&DBPort=13306&DBName=OpManagerDB&DBUserName=postgres&namedInstance=opmNamedInstance&instance=opmInstance&SSLEnabled=false
ME ADManager Plus
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=ADMPMonitor&hostname=[HOST]&port=[PORT]&authEnabled=[AUTHENABLED]&username=[USERNAME]&password=[PASSWORD]&displayname=[DISPLAYNAME]&JNDIPath=[JNDIPATH]&MonitorPGSQLDB=[Yes/No]&dbtype=[DBType]&DBHost=[DatabaseHost]&DBName=[DataBaseName]&DBPort=[DataBasePort]&DBUserName=[DataBaseUserName]&DBPassword=[DBPassword]&namedInstance=[IsNameInstance]&instance=[instance]&SSLEnabled=[SSLEnabled]
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.
| Field | Description |
|---|
| hostname | The name or Ip address of the host where ADManager Plus is running. |
| port | The Running Port of ADManager Plus. |
| authEnabled | Specifies if authentication is enabled. |
| username and password | Credential of the user. |
| displayname | The displayname of the ADManager Plus monitor. |
| JNDIPath | The JNDIPATH for installation of ADManager Plus. |
| MonitorPGSQLDB | Specify if you wish to monitor PGSQL Database with Yes/No. Displaying the respective tab in UI depends on this value. (Case Sensitive) |
| dbtype | The Database Type. Values can be pgsql or mssql. (Case Sensitive) |
| DBName, DBPort, DBUserName and DBPassword | PostgresSQL database credentials. |
| SSLEnabled | Specifies if SSL enabled for ADManager Plus. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=ADMPMonitor&hostname=localhost&port=1991&authEnabled=false&username=admin&password=appman&displayname=test&JNDIPath=/jmxrmi&MonitorPGSQLDB=Yes&dbtype=pgsql&DBHost=apm-host&DBName=DB&DBPort=13306&DBUserName=postgres&DBPassword=postgres&namedInstance=false&SSLEnabled=false
REST API Monitor
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[API Key]&type=RESTAPIMonitor&displayname=[Display Name]&API=[REST API URL]&Timeout=[Timeout Value in Seconds]&Method=[GET/POST/PUT/DELETE]&RespType=[XML]&UserName=[Username]&Password=[Password]&ContentCheck=[True/False]&contains=[CONTAINS]¬Contain=[NOTCONTAINS]&isCaseSensitive=[True/False]&CredentialDetails=[CREDENTIALDETAILS]&customHeaders=[CUSTOM HEADERS]
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer to the list of common request parameters.
| Parameter | Description |
|---|
| type | The type of the monitor you want to add. Value should be RESTAPIMonitor |
| displayname | The display name of the monitor. |
| API | The API call to be monitored. |
| Timeout | The amount of time spent by Applications Manager to establish a connection with the server hosting the API service (in seconds). |
| Method | The Form Submission method used to access the API. (GET/POST/PUT/DELETE) |
| payLoadType | The format in which request data will be sent (applicable only for POST & PUT methods). Value can be FORM, Text, XML or JSON. |
| payLoad | The request data (the format should match the payLoadType specified). |
| UserName | Username of the API, if the REST API call requires basic authentication. |
| Password | Password of the API, if the REST API call requires basic authentication. |
| customHeaders | The headers to establish a connection with the API server. Use _sep_ to separate the header name and value. For specifying multiple headers, use the separator # (Please encode the request parameters if they are sent via GET).
Example:User-Agent_sep_Mozilla/5.0 (Windows NT 6.3; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.86 Safari/537.36#Accept-Charset_sep_utf-8 |
| RespType | The type of response to be expected from the REST API. (Text/XML/JSON). |
| ContentCheck | Indicates whether the content check needs to be performed on the API response. (True or False) |
| contains | Content that should be present in the API response. |
| notContain | Content that should not be present in the API response. |
| isCaseSensitive | Indicates whether case-sensitive content check needs to be performed on the API response. (True or False) |
| isRegEx | Indicates whether regex check needs to be performed on the API response. (True or False) |
| CredentialDetails | Type of authentication to be performed on REST API. Value should be "nocm" for Basic authentication, "cm" for Credential manager, "oauth" for OAuth Token, "WEBTOKEN" for Web Token. |
| credentialID | Credential ID of a credential from Credential Manager. Applicable only when the value for the parameter CredentialDetails is "cm". |
| OAuthVal | ID of the OAuth provider. Applicable only when the value for the parameter CredentialDetails is "oauth". |
| provider | Name of the OAuth provider. Not required if the value for the parameter OAuthVal is specified.
Applicable only when the value for the parameter CredentialDetails is "oauth". |
| WEBTOKENVAL | ID of the Web Token. Applicable only when the value for the parameter CredentialDetails is "WEBTOKEN". |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=RESTAPIMonitor&displayname=restapiMonitor&API=https://apm-prod-server:8443/AppManager/json/ListAlarms&Timeout=50&Method=GET&RespType=JSON&customHeaders=Pragma_sep_no-cache%23Connection_sep_keep-alive&ContentCheck=True&contains=alarm¬Contains=threshold&isCaseSensitive=True&CredentialDetails=oauth&OAuthVal=123456789&customHeaders=Auth_sep_You
Webpage Analyzer
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&webpageURL=[WEBPAGEURL]&pageLoadTimeout=[PAGELOADTIME]&timeToWaitForAjax=[WAITTIME]&Method=[GET/POST]&UserName=[USERNAME]&Password=[PASSWORD]&blockDomains=[DOMAINS TO BLOCK]&ContentCheck=[True/False]&RegexString=[REGEXSTRING]&contains=[STRING TO BE PRESENT]¬Contain=[STRING NOT TO BE PRESENT]&isCaseSensitive=[True/False]&enableSSLMonitoring=[True/False]&domain=[DOMAIN NAME]&port=[PORT]&isProxyNeeded=[True/False]&ignoreHostNameError=[True/False]&Timeout=[TIMEOUT]&payLoad=[PAYLOAD]&customHeaders=[CUSTOM HEADERS]&monitorLeafCertOnly=[IGNOREMISMATCHERROR]
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer to the list of common request parameters.
| Parameter | Description |
|---|
| type | The type of the monitor you want to add. Value should be WebpageAnalyzer |
| displayname | The display name of the monitor. |
| webpageURL | The URL of the webpage to be monitored. |
| pageLoadTimeout | Maximum time (in seconds) for the page to load. |
| timeToWaitForAjax | Time (in seconds) to wait after page load. |
| Method | This method specifies how to send form-data. Value should be either GET or POST. |
| UserName | Username of the webpage if the URL requires Basic authentication. |
| Password | Password of the webpage if the URL requires Basic authentication. |
| blockDomains | Domains to block from monitoring separated by "|". Example: adshost2.com|ad.turn.com |
| ContentCheck | Option to add content check for response. (True or False) |
| RegexString | Regular expression to be checked in the response if it is present or not. |
| contains | Content to be present in response. |
| notContain | Content that should not be present in response. |
| isCaseSensitive | Option to perform a case sensitive keyword search. (True or False) |
| enableSSLMonitoring | Option to enable SSL/TLS certificate monitoring. (True or False) |
| domain | The domain name for which the SSL/TLS certificate is required to be monitored. |
| port | The port number where the domain server is running. |
| isProxyNeeded | Use isProxyNeeded if the server is connected through proxy. (True or False) |
| ignoreHostNameError | Option to ignore Certificate name mismatch error. (True or False) |
| Timeout | The timeout value in seconds. |
| payLoad | The data that will be sent to the website after the connection is established. |
| customHeaders | The headers to be specified to establish a connection with the HTTPS server. Use sep to separate the header name and value. For specifying multiple headers, use the separator _. |
| monitorLeafCertOnly | Option to ignore invalid root and intermediate certificate. If the value is not passed, then it is assumed to be true. (true or false) |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=WebpageAnalyzer&displayname=WPA&webpageURL=https://www.zoho.com/&pageLoadTimeout=30&timeToWaitForAjax=1&Method=GET&UserName=admin&Password=appman&blockDomains=www.zohowebstatic.com&ContentCheck=True&RegexString=zi*&contains=APM¬Contain=ME&isCaseSensitive=True&enableSSLMonitoring=True&domain=www.zoho.com&port=443&isProxyNeeded=False&ignoreHostNameError=True&Timeout=120&payLoad=abc&customHeaders=Auth_sep_You&monitorLeafCertOnly=false
WebSocket Monitor
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[API Key]&type=WebSocketMonitor&displayname=[Display Name]&WebSocketURL=[WebSocket Endpoint URL]&timeout=[Timeout Value in Seconds]&UserName=[User Name]&Password=[Password]&payLoad=[WebSocket payload]&ContentCheck=[True/False]&contains=[Contains]¬Contain=[Not Contains]&isCaseSensitive=[True/False]&isRegEx=[True/False]&CredentialDetails=[CredentialDetails]
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below. Also, refer to the list of common request parameters.
| Parameter | Description |
|---|
| type | The type of monitor you want to add. Value should be WebSocketMonitor. |
| displayname | The display name of the monitor. |
| WebSocketURL | The WebSocket URL to be monitored can be either a ws:// or wss:// endpoint. |
| timeout | The amount of time (in seconds) that APM waits to establish a connection with the server hosting the WebSocket service. This also serves as the timeout duration for APM to listen and collect data from the service. |
| customHeaders | The headers to establish a connection with the API server. Use sep to separate the header name and value. For specifying multiple headers, use the separator #. |
| payLoad | The data that will be sent to the WebSocket server after the connection is established. Currently, only String type payloads are supported. |
| protocol | The version of the SSL/TLS protocol. The value should be SSLv3 / TLSv1 / TLSv1.1 / TLSv1.2 / TLSv1.3.
Note: Applicable only for wss:// endpoints. |
| ignoreHostNameError | Specify whether you want to ignore the hostname error. A hostname error occurs when the domain in the server’s SSL/TLS certificate does not match the domain in the monitored WebSocket endpoint. The possible values are True or False.
Note: Applicable only for wss:// endpoints. |
| trustCheck | Specify True if you want to bypass the trust validation of the wss:// endpoint. Otherwise, specify False to perform server certificate validation during the SSL/TLS handshake.
Note: Applicable only for wss:// endpoints. |
| ContentCheck | Indicates whether the content check needs to be performed on the WebSocket response. (True or False) |
| contains | Content that should be present in the WebSocket response. |
| notContains | Content that should not be present in the WebSocket response. |
| isCaseSensitive | Indicates whether case-sensitive content check needs to be performed on the WebSocket response. (True or False) |
| isRegEx | Indicates whether regex check needs to be performed on the WebSocket response. (True or False) |
| CredentialDetails | Type of authentication to be performed on WebSocket Endpoint. Value should be nocm for Basic authentication, cm for Credential manager, oauth for OAuth Token, WEBTOKEN for Web Token. |
| credentialID | Credential ID of a credential from Credential Manager. Applicable only when the value for the parameter CredentialDetails is cm. |
| OAuthVal | ID of the OAuth provider. Applicable only when the value for the parameter CredentialDetails is oauth. |
| provider | Name of the OAuth provider. Not required if the value for the parameter OAuthVal is specified.
Applicable only when the value for the parameter CredentialDetails is oauth. |
| WEBTOKENVAL | ID of the Web Token. Applicable only when the value for the parameter CredentialDetails is WEBTOKEN. |
Sample Request
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=WebSocketMonitor&displayname=websocketMonitor&WebSocketURL=wss://echo.websocket.events&timeout=15&customHeaders=Auth_sep_You%23Mean_sep_tit&payLoad=abc&protocol=TLSv1.3&ignoreHostNameError=True&trustCheck=True&contains=abc¬Contain=def &isCaseSensitive=True&isRegEx=True&ContentCheck=True&CredentialDetails=oauth&OAuthVal=123456789
