# 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: - [Cassandra](https://www.manageengine.com/products/applications_manager/help/database-servers.html#cass) - [CouchBase](https://www.manageengine.com/products/applications_manager/help/database-servers.html#couchbase) - [Dameng DB](https://www.manageengine.com/products/applications_manager/help/database-servers.html#damengdb) - [HBase](https://www.manageengine.com/products/applications_manager/help/database-servers.html#hbase) - [IBM DB2](https://www.manageengine.com/products/applications_manager/help/database-servers.html#ibmdb2) - [IBM DB2 for i](https://www.manageengine.com/products/applications_manager/help/database-servers.html#ibmdb2fori) - [IBM Informix](https://www.manageengine.com/products/applications_manager/help/database-servers.html#ibminformix) - [Kingbase DB](https://www.manageengine.com/products/applications_manager/help/database-servers.html#kingbasedb) - [Memcached](https://www.manageengine.com/products/applications_manager/help/database-servers.html#memcached) - [MongoDB](https://www.manageengine.com/products/applications_manager/help/database-servers.html#mongo) - [MS SQL](https://www.manageengine.com/products/applications_manager/help/database-servers.html#mssql) - [MySQL](https://www.manageengine.com/products/applications_manager/help/database-servers.html#mysql) - [MySQL InnoDB ClusterSet and Cluster](https://www.manageengine.com/products/applications_manager/help/database-servers.html#mysqlinnodb) - [Neo4j](https://www.manageengine.com/products/applications_manager/help/database-servers.html#neo) - [Oracle](https://www.manageengine.com/products/applications_manager/help/database-servers.html#oracle) - [Oracle NoSQL](https://www.manageengine.com/products/applications_manager/help/database-servers.html#oracle_nosql) - [Oracle RAC](https://www.manageengine.com/products/applications_manager/help/database-servers.html#rac) - [PostgreSQL](https://www.manageengine.com/products/applications_manager/help/database-servers.html#postgresql) - [Redis](https://www.manageengine.com/products/applications_manager/help/database-servers.html#redis) - [SAP HANA](https://www.manageengine.com/products/applications_manager/help/database-servers.html#sap_hana) - [SAP HANA MDC](https://www.manageengine.com/products/applications_manager/help/database-servers.html#sap_hana_mdc) - [SAP ASE Servers (Sybase ASE/Sybase SQL Servers)](https://www.manageengine.com/products/applications_manager/help/database-servers.html#sybase) - [SAP Replication Servers (Sybase ASE Replication Servers)](https://www.manageengine.com/products/applications_manager/help/database-servers.html#sybaseRepServer) - [SQL Anywhere](https://www.manageengine.com/products/applications_manager/help/database-servers.html#sqlanywhere) **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 Refer to the [list of common request parameters](https://www.manageengine.com/products/applications_manager/help/addmonitor-api.html#requestparameters). | Field | Description | |---|---| | type | The type of 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 on 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 Refer to the [list of common request parameters](https://www.manageengine.com/products/applications_manager/help/addmonitor-api.html#requestparameters). | Field | Description | |---|---| | type | The type of 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 on which the 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 Refer to the [list of common request parameters](https://www.manageengine.com/products/applications_manager/help/addmonitor-api.html#requestparameters). | Field | Description | |---|---| | type | The type of 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 on 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 Refer to the [list of common request parameters](https://www.manageengine.com/products/applications_manager/help/addmonitor-api.html#requestparameters). | Field | Description | |---|---| | type | The type of database you want to add. Value should be *Memcached*. | | host | The name of the host on which the Memcached server is running. | | port | The port number where the 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]&validateServerCertificate=[true/false]&kerberos=[true/false]&driverType=[microsoftjdbcdriver/jtdsjdbcdriver]&netmask=[SUBNETMASK] ``` ### Request Parameters Refer to the [list of common request parameters](https://www.manageengine.com/products/applications_manager/help/addmonitor-api.html#requestparameters). | Field | Description | |---|---| | type | The type of 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 on 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 an 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 on the server, this value will be true. | | kerberos | Indicates whether Kerberos Authentication is enabled in the server (*True* or *False*). | | validateServerCertificate | *(Applicable only for Microsoft JDBC Driver)* Indicates whether SSL certificate validation should be performed. | | driverType | The driver type to connect to the database. Value should be *microsoftjdbcdriver* or *jtdsjdbcdriver*. | | 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** should be *jtdsjdbcdriver* since support has been removed in the [current version of Microsoft JDBC Driver](https://docs.microsoft.com/en-us/sql/connect/jdbc/microsoft-jdbc-driver-for-sql-server-support-matrix?view=sql-server-ver15#sql-version-compatibility). ### 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 ``` *The remaining database sections follow the same structure as above, including Syntax, Request Parameters (with tables), and Sample Request blocks for: MySQL, MySQL InnoDB ClusterSet & Cluster, Oracle, Oracle RAC, Oracle NoSQL, PostgreSQL, SAP ASE Servers, SAP HANA, SAP HANA MDC, HBase, Cassandra, Redis, MongoDB, CouchBase, Neo4j, SQL Anywhere, SAP Replication Servers, Dameng DB, and Kingbase DB — preserving all parameters, tables, and sample requests exactly as in the source.*