AddMonitor APIs - Database Servers
This section explains how to use the AddMonitor API to add monitors of the category type 'Database Servers'. The following databases are supported:
Supported HTTP methods: POST
Allowed roles: Administrator
IBM DB2
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&instance=[INSTANCE]&useSSL=[true/false]&netmask=[SUBNETMASK]
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 db2. |
| username | The user name of the user who has permission to access the DB2 database. |
| host | The name of the host in which DB2 is running. |
| password | The password of the user who has permission to access the DB2 database. |
| port | The port number where DB2 is running. |
| instance | The database/instance name. |
| useSSL | Indicates whether SSL is enabled for the DB2 server. (true or false) |
| netmask | Indicates the subnet mask value. This is an optional field. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee &type=db2&displayname=appmanagerdb2&username=admin&host=app-xp4&password=appman&port=50000&instance=SAMPLEDB&useSSL=true&netmask=255.255.255.0
IBM DB2 for i
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&username=[USERNAME]&HostName=[HOST]&password=[PASSWORD]&netmask=255.255.255.0&useSSL=[true/false]
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 AS400DB2. |
| username | The user name of the user who has permission to access the DB2 for i database. |
| HostName | The name of the host in which DB2 for i database is running. |
| password | The password of the user who has permission to access the DB2 for i database. |
| useSSL | Indicates whether SSL is enabled for the DB2 for i server. (true or false) |
| netmask | The subnet mask value. This is an optional field. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee &type=db2&displayname=appmanagerdb2&username=admin&HostName=app-xp4&password=appman&netmask=255.255.255.0&useSSL=true
IBM Informix
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=type&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&informixserver=[DATABASE SERVER NAME]&username=[USERNAME]&password=[PASSWORD]
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 Informix. |
| username | The user name of the user who has permission to access the Informix database. |
| host | The name of the host in which the Informix database is running. |
| password | The password of the user who has permission to access the Informix database.. |
| port | The port number where the Informix database is running. |
| instance | The database/instance name. |
| informixserver | The name of your Informix server. By default, the name will be ol_machinename. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Informix&displayname=test&hostname=app-win7-64-1&port=9088&username=admin&password=appman&informixserver=ol_informix1210
Memcached
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&Transaction=[TRANSACTION]
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 Memcached. |
| host | The name of the host in which Memcached server is running. |
| port | The port number where Memcached server is running. |
| Transaction | Denotes if transaction test is enabled or not. Value should be either yes or no |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee
&type=Memcached&displayname=mem_test&host=app-linux2&port=11211&Transaction=yes
MS SQL
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME] &username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&namedInstance=[true/false]&instance=[INSTANCE]&authentication=[AUTHENTICATION]&encryption=[true/false]&kerberos=[true/false]&driverType=[microsoftjdbcdriver/jtdsjdbcdriver]&netmask=[SUBNETMASK]
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 ms sql. |
| username | The name of the user who has permission to access the MS SQL server. |
| host | The name of the host in which MS SQL is running. |
| password | The password of the user who has permission to access the MS SQL server. |
| port | The port number where MS SQL is running. |
| instance | The database/instance name. This is optional field. |
| authentication | The authentication type. Value should be either SQL, NTLM, Kerberos, or NativeAuthentication. |
| namedIntance | If the SQL server is a named instance, this value will be true. |
| encryption | If 'Force Encryption' is enabled in the server, this value will be true. |
| kerberos | Indicates whether Kerberos Authentication is enabled in the server. (True or False) |
| driverType | The driverType has to be mentioned as microsoftjdbcdriver or jtdsjdbcdriver in order to choose the required driver for connecting to the database for data collection. This is optional and the default driver is microsoftjdbcdriver. |
| netmask | Indicates the subnet mask value. This is an optional field. |
Note: If you are adding SQL Server 2008 or 2008 R2 version, then the value for driverType option should be jtdsjdbcdriver since support for SQL 2008 & 2008 R2 has been removed in the current version of Microsoft JDBC Driver.
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=MS SQL&displayname=appmanagermssql&username=admin&host=app-xp2&password=appman&port=1433&namedInstance=true&instance=MSSQLSERVER&authentication=SQL&encryption=true&kerberos=true&driverType=jtdsjdbcdriver&netmask=255.255.255.0
MySQL
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&instance=[INSTANCE]&authentication=[AUTHENTICATION]&useSSL=[true/false]&netmask=[SUBNETMASK]&mysqlDriverType=[mariadbdriver/mysqldriver]
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 mysql. |
| username | The name of the user who has permission to access the MySQL server. |
| host | The name of the host in which MySQL is running. |
| password | The password of the user who has permission to access the MySQL server. |
| port | The port number where MySQL is running. |
| instance | The database/instance name. This is optional field. |
| authentication | The authentication type. Value should be SQL |
| useSSL | Enabling this option will force the server to authenticate in both ways (i.e client-auth and server-auth). This is optional. |
| netmask | Indicates the subnet mask value. This is an optional field. |
| mysqlDriverType | The type of driver used to connect to the MySQL server. Value should be mariadbdriver or mysqldriver. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=mysql&displayname=appmanagermysql&username=admin&host=
apmhost&password=appman&port=13329&instance=mysql&authentication=SQL&useSSL=true&netmask=255.255.255.0&mysqlDriverType=mysqldriver
MySQL InnoDB ClusterSet & Cluster
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&instance=[INSTANCE]&authentication=[AUTHENTICATION]&useSSL=[true/false]&netmask=[SUBNETMASK]&mysqlDriverType=[mariadbdriver/mysqldriver]&discoverCluster=true
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 mysql. |
| username | The name of the user who has permission to access the MySQL server. |
| host | The name of the host on which MySQL is running. |
| password | The password of the user who has permission to access the MySQL server. |
| port | The port number where MySQL is running. |
| instance | The database/instance name. This is an optional field. |
| authentication | The authentication type. Value should be SQL. |
| useSSL | Enabling this option will force the server to authenticate in both ways (i.e., client-auth and server-auth). This is optional. |
| netmask | Indicates the subnet mask value. This is an optional field. |
| mysqlDriverType | The type of driver used to connect to the MySQL server. Value should be mariadbdriver or mysqldriver. |
| discoverCluster | When enabled, if the MySQL server being added is part of an InnoDB cluster, Applications Manager will add the corresponding InnoDB ClusterSet and Clusters as monitor groups, discover all associated nodes, and associate them with their respective cluster groups. |
Oracle
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&instance=[INSTANCE]&SSLEnabled=[isSSLEnabled]&discoverPDB=[DiscoverPDB]&oracleSocketTimeout=[SocketReadTimeout]&oracleQueryTimeout=[QueryExecutionTimeout]&netmask=[SUBNETMASK]&discoverInterval=[INTERVAL]
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 oracle. |
| username | The name of the user who has permission to access the Oracle database. |
| host | The name of the host in which Oracle is running. |
| password | The password of the user who has permission to access the Oracle database. |
| port | The port number where Oracle is running. |
| instance | The database/instance name. This is optional field. |
| SSLEnabled | True if the SSL is enabled otherwise the value is false. |
| discoverPDB | Option to enable discovery and monitoring of Pluggable Database(s). (yes or no) |
| oracleSocketTimeout | Socket Read Timeout value for database connection. Default value is 300 seconds. |
| oracleQueryTimeout | Query Execution Timeout value during data collection query execution. Default value is 60 seconds. |
| netmask | Indicates the subnet mask value. This is an optional field. |
| discoverInterval | The time interval for automatically discovering and monitoring child monitors in minutes. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=oracle&displayname=appmanageroracle&username=admin&host=swissql-xp1&password=appman&port=1521&instance=orcl&SSLEnabled=false&discoverPDB=yes&oracleSocketTimeout=300&oracleQueryTimeout=60&netmask=255.255.255.0&discoverInterval=10
Oracle RAC
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&instance=[INSTANCE]&SSLEnabled=[isSSLEnabled]&mapExistingOracleInstances=[MapExistingOracleInstances]&discoverPDB=[DiscoverPDB]&discoverOracleRACNodes=[discoverOracleRACNodes]&oracleSocketTimeout=[SocketReadTimeout]&oracleQueryTimeout=[QueryExecutionTimeout]&netmask=[SUBNETMASK]&discoverInterval=[INTERVAL]
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 oracleRAC. |
| username | The name of the user who has permission to access the Oracle RAC server. |
| host | The name of the host in which Oracle RAC server is running. |
| password | The password of the user who has permission to access the Oracle RAC server. |
| port | The port number where Oracle Scan Listener is running. |
| instance | The database/instance name to be monitored. This is optional field. |
| SSLEnabled | Indicates whether SSL is enabled for the server. (true or false) |
| mapExistingOracleInstances | Option to map all the exiting RAC Type Oracle Monitors to the RAC monitor. Default value will be 'Yes'. (Yes or No) |
| discoverPDB | Option to enable discovery and monitoring of Pluggable Database(s). (yes or no) |
| discoverOracleRACNodes | Option to discover and monitor all the Oracle RAC nodes as Server monitors. (true or false) |
| oracleSocketTimeout | Socket Read Timeout value for database connection. Default value is 300 seconds. |
| oracleQueryTimeout | Query Execution Timeout value during data collection query execution. Default value is 60 seconds. |
| netmask | Indicates the subnet mask value. This is an optional field. |
| discoverInterval | The time interval for automatically discovering and monitoring child monitors in minutes. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=ORACLE-RAC&displayname=testoracleRAC&username=admin&host=oraclerac-host&password=appman&port=1521&instance=orcl&SSLEnabled=false&mapExistingOracleInstances=Yes&discoverPDB=yes&discoverOracleRACNodes=true&oracleSocketTimeout=300&oracleQueryTimeout=60&netmask=255.255.255.0&discoverInterval=10
Oracle NoSQL
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[apikey]&type=OracleNoSQL&displayname=[Displayname]&HostName=[HostName]&Port=[Port]&UserName=[UserName]&Password=[Password]&JNDIPath=/jmxrmi
Request Parameters
The parameters involved in the API request are described below. Also, refer to the list of common request parameters.
| Field | Description |
|---|
| apikey | API key to create the Oracle NoSQL monitor |
| type | The type of the database you want to add. Value should be OracleNoSQL. |
| displayname | Display name of the Oracle NoSQL monitor |
| hostname | The name of the host in which Oracle NoSQL is running. |
| port | The port number where Oracle is running. |
| username | The name of the user who has permission to access the Oracle NoSQL database. |
| password | The password of the user who has permission to access the Oracle NoSQL database. |
| JNDIPath | JNDI path to be used. Default value is /jmxrmi. This is an optional field. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=OracleNoSQL&displayname=OracleNoSQL&HostName=172.20.6.200&Port=5000&UserName=admin&Password=appman&JNDIPath=/jmxrmi
PostgreSQL
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&instance=[INSTANCE]
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 PostgreSQL. |
| host | The name of the host in which PostgreSQL is running. |
| port | The port number where PostgreSQL is running. |
| username | The name of the user who has permission to access the PostgreSQL database. |
| password | The password of the user who has permission to access the PostgreSQL database. |
| instance | The database/instance name. This is optional field. |
SSLEnabled | True if the SSL is enabled otherwise the value is false. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee
&type=PostgreSQL&displayname=postSQL&host=app-xp2&port=5432&username=admin&password=appman&instance=postgres&SSLEnabled=false
SAP ASE Servers (Sybase ASE/Sybase SQL Servers)
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&instance=[INSTANCE]&jconnect=[JCONNECT]&netmask=[SUBNETMASK]
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 SAP-ASE-DB-server. |
| host | The name of the host in which SAP ASE is running. |
| port | The port number where SAP ASE is running. |
| username | The name of the user who has permission to access the SAP ASE database. |
| password | The password of the user who has permission to access the SAP ASE database. |
| instance | The database/instance name. This is optional field. |
| jconnect | Option to connect using JConnect to collect data. (true or false) |
| netmask | Indicates the subnet mask value. This is an optional field. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee &type=SAP-ASE-DB-server&displayname=appmanagersapase&username=admin&host=app-xp3&password=appman&port=5000&instance=master&jconnect=true&netmask=255.255.255.0
SAP HANA
Syntax
To Monitor OnPremise System:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]& type=SapHana& displayname=[DISPLAYNAME]& host=[HOST]& isOndemand=false& port=[PORT]& dbUser=[DB_USERNAME]& dbPassword=[DB_PASSWORD]& instance=[INSTANCE]& timeout=[Connection timeout]& SSLEnabled=[isSSLEnabled]& hostnameInCertificate=[host] &HA=[true/false] &failoverDetails=[FailoverHost:FailoverPort]
To Monitor OnDemand System:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]& type=SapHana& displayname=[DISPLAYNAME]& host=[HOST]& isOndemand=true& accountName=[ACCOUNT_NAME]& username=[USER_NAME]& password=[ACCOUNT_PASSWORD]& dbUser=[DB_USERNAME]& dbPassword=[DB_PASSWORD]& instance=[INSTANCE]& timeout=[Connection timeout]& SSLEnabled=[isSSLEnabled] &HA=[true/false] &failoverDetails=[FailoverHost:FailoverPort]
Request Parameters
| Field | Description |
|---|
| Host | Hostname or Landscape Host. |
| Port | IndexServer SQL Port. Default value is 30015.[Required only for On Premise Setup] |
| isOndemand | Value is true for On Demand setup, false for On Premise setup. |
| accountName | On-Demand cloud account name. [Required only for On-Demand setup] |
| username | UserName for the cloud account. [Required only for On demand Setup] |
| password | Password for the cloud account. [Required only for On demand Setup] |
| dbUser | Database User Name |
| dbPassword | Database Password |
| instance | Instance Name |
| timeout | Connection Timeout. Default value is 20 seconds. |
| SSLEnabled | Indicates if SSL is enabled or not (true/false). |
| hostnameInCertificate | Specifies the host name used to verify the server’s identity. |
| HA | Indicates whether High Availability (HA) is enabled or disabled for the monitored database. |
| Failover Host | Specifies the failover/secondary hosts. |
| Failover Port | Specifies the failover/secondary ports. |
Sample Request
https://localhost:9441/AppManager/xml/AddMonitor?apikey=44db8d2576378901a3d37f533fd46158&type=SapHana&displayname=sap&host=hanahana&isOndemand=false&port=30282&dbUser=sapdb&dbPassword=db23&instance=HDB&timeout=10&SSLEnabled=false&HA=true&failoverDetails=apmhost1:3001,apmhost2:3002
SAP HANA MDC
Syntax
To Monitor OnPremise System:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=SapHanaMDC&displayname=[DISPLAYNAME]&host=[HOST]&isOndemand=false&port=[PORT]&dbUser=[DB_USERNAME]&dbPassword=[DB_PASSWORD]&timeout=[Connection timeout]&SSLEnabled=[isSSLEnabled]&hostnameInCertificate=[host]
To Monitor OnDemand System:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=SapHanaMDC&displayname=[DISPLAYNAME]&host=[HOST]&isOndemand=true&accountName=[ACCOUNT_NAME]&username=[USER_NAME]&password=[ACCOUNT_PASSWORD]&dbUser=[DB_USERNAME]&dbPassword=[DB_PASSWORD]&timeout=[Connection timeout]&SSLEnabled=[isSSLEnabled]
Request Parameters
| Field | Description |
|---|
| Host | Hostname/ Landscape Host |
| Port | NameServer SQL Port. Default 30015. [Required only for On Premise Setup] |
| isOndemand | Value is true for On Demand setup, false for On Premise setup. |
| accountName | On demand CLoud Account Name. [Required only for On demand Setup] |
| username | UserName for the cloud account. [Required only for On demand Setup] |
| password | Password for the cloud account. [Required only for On demand Setup] |
| dbUser | Database User Name |
| dbPassword | Database Password |
| timeout | Connection Timeout. Default value is 20 seconds. |
| SSLEnabled | Indicates if SSL is enabled or not (true/false). |
| hostnameInCertificate | Specifies the host name used to verify the server’s identity. |
Sample Request
To Monitor OnPremise System:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&displayname=RestHana&type=SapHanaMDC&host=hanatrial.ondemand.com&
isOndemand=false&accountName=s0004447540trial&username=admin&password=appman&dbUser=SYSTEM&
dbPassword=dbappman&timeout=20&SSL=true&hostnameInCertificate=[host]
To Monitor OnDemand System:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&displayname=RestHana&type=SapHanaMDC&host=hanatrial.ondemand.com&
isOndemand=true&accountName=s0004447540trial&username=admin&password=appman&dbUser=SYSTEM&
dbPassword=dbappman&timeout=20&SSL=true&hostnameInCertificate=[host]
HBase
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[apikey]&type=HBase&displayname=[Displayname]&HostName=[HostName]&Port=[Port]&UserName=[UserName]&Password=[Password]&JNDIPath=/jmxrmi
Request Parameters
The parameters involved in the API request are described below.Also, refer to the list of common request parameters.
| Field | Description |
|---|
| apikey | API key to create the HBase monitor |
| type | The type of the database you want to add. Value should be HBase |
| displayname | Display name of the HBase monitor |
| hostname | The name of the host in which HBase is running. |
| port | The port number where HBase is running. |
| username | The name of the user who has permission to access the HBase database. |
| password | The password of the user who has permission to access the HBase database. |
| JNDIPath | JNDI path to be used |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=HBase&displayname=HBase&HostName=APP-W8-AIO-5&Port=5000&UserName=admin&Password=appman&JNDIPath=/jmxrmi
Cassandra
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Cassandra&displayname=Cassandra&host=[Host Name]&port=[Port Number]&discoverclusternodes=[non mandatory column, if given the value should be 'Yes']&authRequired=[non mandatory column, if given the value should be 'true']&username=[username]&password=[password]
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 Cassandra. |
| host | The name of the host in which Cassandra database is running. |
| port | The port number where Cassandra database is running. |
| username | The name of the user who has permission to access the Cassandra database. |
| password | The password of the user who has permission to access the Cassandra database. |
| discoverclusternodes | Specify if the Cluster Nodes must be discovered. Value can be YES/NO. This column is not mandatory. |
| authRequired | Specify if authentication is required. Value can be True/False. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Cassandra&displayname=Cassandra&host=172.20.7.36&port=7199&
username=admin&password=appman
Redis
Syntax
For Default Authentication:
http://[host]:[port]/AppManager/xml/AddMonitor?apikey=[apikey]&type=Redis&host=[host]&port=[port]&discoverclusternodes=[non mandatory column, if given the value should be 'Yes']&displayname=[displayname]&AuthenticationType=[DefaultAuth]&password=[password]
For ACL Authentication:
http://[host]:[port]/AppManager/xml/AddMonitor?apikey=[apikey]&type=Redis&host=[host]&port=[port]&discoverclusternodes=[non mandatory column, if given the value should be 'Yes']&displayname=[displayname]&AuthenticationType=[ACLAuth]&username=[username]&password=[password]
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 Redis. |
| host | The name of the host in which Redis is running. |
| port | The port number where Redis is running. |
| username | The name of the user who has permission to access the Redis database. |
| password | The password of the user who has permission to access the Redis database. |
| discoverclusternodes | Specify if the Cluster Nodes must be discovered. Value can be YES/NO. This column is not mandatory. |
| AuthenticationType | Specify the type of authentication. Value can be DefaultAuth/ACLAuth. |
Sample Request
For Default Authentication:
http://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Redis&host=172.20.6.200&port=6379&discoverclusternodes=[non mandatory column, if given the value should be 'Yes']&displayname=redis&AuthenticationType=[DefaultAuth]&password=appman
For ACL Authentication:
http://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Redis&host=172.20.6.200&port=6379&discoverclusternodes=[non mandatory column, if given the value should be 'Yes']&displayname=Redis&AuthenticationType=[ACLAuth]&username=admin&password=appman
MongoDB
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=MongoDB&displayname=MongoDB&host=[Host Name]&port=[Port Number]&discoverchildren=[non mandatory column, if given the value should be 'Yes']&authRequired=[non mandatory column, if given the value should be 'true']&username=[username]&password=[password]&sslenabled=[sslenabled]
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 MongoDB. |
| host | The name of the host in which MongoDB is running. |
| port | The port number where MongoDB is running. |
| username | The name of the user who has permission to access the Mongo database. |
| password | The password of the user who has permission to access the Mongo database. |
| discoverclusternodes | Specify if the Cluster Nodes must be discovered. Value can be YES/NO. This column is not mandatory. |
| authRequired | Specify if authentication is required. Value can be True/False. |
| sslenabled | Specify if SSL is enabled or not. Value can be true/false. |
| discoverchildren | Values can be true/false. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=MongoDB&displayname=MongoDB&host=172.20.6.200&port=6379&password=appman&sslenabled=true
CouchBase
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]
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 CouchBase. |
| displayname | The display name of the Couchbase database. |
| host | The name of the host in which CouchBase is running. |
| port | The port number where CouchBase is running. |
| username | The name of the user who has permission to access the CouchBase database. This is an optional field. |
| password | The password of the user who has permission to access the CouchBase database. This is an optional field. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Couchbase&displayname=Couchmonitoring&host=app-win7-64-4.csez.zohocorpin.com&port=8091&username=admin&password=appman
Neo4j
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[ API KEY ]&type=Neo4j&displayname=[DISPLAYNAME]&HostName=[Host]&Port=[Port]&UserName=[UserName]&Password=[Password]&DiscoverNode=yes/no
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 Neo4j. |
| HostName | The name of the host in which Neo4j is running. |
| Port | The bolt port number where Neo4j is running. |
| UserName | The name of the user who has permission to access the Neo4j database. |
| Password | The password of the user who has permission to access the Neo4j database. |
| DiscoverNode | Specify if the Cluster Nodes must be discovered. Value can be YES/NO. This column is not mandatory. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Neo4j&displayname=DISPLAYNAME&HostName=app-w8-aio-5&Port=7687&UserName=admin&Password=appman&DiscoverNode=yes
SQL Anywhere
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[Key]&type=[type]&displayname=[DisplayName]&username=[userid]&host=[Host]&Password=[password]&port=[port]
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 SQLAnywhere-DB-server. |
| displayname | Display name of the monitor. |
| username | The name of the user who has permission to access the SQL Anywhere database. |
| host | The name of the host in which SQL Anywhere server is running. |
| Password | The password of the user who has permission to access the SQL Anywhere database. |
| port | The port number where SQL Anywhere is running. Default port is 2638. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=SQLAnywhere-DB-server&displayname=sqlanywhere-demo&username=admin&host=hostname&Password=appman&port=2638
SAP Replication Servers (Sybase ASE Replication Servers)
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME] &username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&instance=[INSTANCE]&netmask=[SUBNETMASK]
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 SAP-ASE-Replication-server. |
| host | The name of the host in which SAP Replication Servers (Sybase ASE Replication Servers) is running. |
| port | The port number where SAP Replication Servers (Sybase ASE Replication Servers) is running. |
| username | The name of the user who has permission to access the SAP Replication Servers (Sybase ASE Replication Servers). |
| password | The password of the user who has permission to access the SAP Replication Servers (Sybase ASE Replication Servers). |
| instance | The database/instance name of the SAP Replication Servers (Sybase ASE Replication Servers). |
| netmask | Indicates the subnet mask value. This is an optional field. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee
&type=SAP-ASE-Replication-server&displayname=appmanagersapaseRepServer&username=admin&host=app-xp3&password=appman&port=5000&instance=master&netmask=255.255.255.0
Dameng DB
Syntax
http:// [Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=DamengDB&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&timeout=[Connection 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 database you want to add. Value should be DamengDB. |
| displayname | Display name of the monitor |
| host | The name of the host in which Dameng DB server is running. |
| port | The port number where Dameng database is running. Default value is 5237. |
| username | The name of the user who has permission to access the Dameng database. |
| password | The password of the user who has permission to access the Dameng database. |
| timeout | Timeout value for database connection. Default value is 40 seconds. |
Sample Request
http://localhost:9200/AppManager/xml/AddMonitor?apikey=6320a695414b2905d9b97f7e63d5d40d&type=DamengDB&displayname=Testing&host=localhost&port=5237&UserName=SYSDBA&Password=Server@123&timeout=40
Kingbase DB
Syntax
http:// [Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=KingbaseDB&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&instance=[INSTANCENAME]&SSLEnabled=[true/false]
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 KingbaseDB. |
| displayname | Display name of the monitor. |
| host | The name of the host in which Kingbase DB server is running. |
| port | The port number where Kingbase database is running. Default value is 5237. |
| instance | The database/instance name. |
| SSLEnabled | Indicates whether SSL is enabled for the Kingbase server. (true or false) |
Sample Request
https://localhost:9091/AppManager/xml/AddMonitor?apikey=c8fea11cfae3e5642b04bc86ca8619e6&type=KingbaseDB&displayname=TestKingbaseDB&host=apm-w10-10&port=54321&username=system&password=Server@123&instance=test&SSLEnabled=false
