AddMonitor APIs - Services
This section explains how to use the AddMonitor API to add monitors of the category type 'Services'. The following services are supported:
Supported HTTP methods: POST
Allowed roles: Administrator
Active Directory
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&CredSSP=[Yes/FALSE]&username=[USERNAME]&password=[PASSWORD]&timeout=[TIMEOUT]&kerberos=[True/False]
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 service you want to add. Value should be 'ActiveDirectory'. |
| host | The name of the host in which the Active Directory service is running. |
| username | The Active Directory username. |
| password | The Active Directory password. |
| timeout | Timeout in seconds for running scripts |
| CredSSP | Specifies if CredSSP Authentication should be used when the monitored AD Server is a non-primary Domain Controller and is present in a different domain other than that of the Applications Manager server domain. The value is "Yes" if CredSSP needs to be enabled. |
| kerberos | Option to enable Kerberos authentication. (True or False) |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=ActiveDirectory&displayname=active_mon&host=app-xp4&username=admin&password=appman&timeout=300&CredSSP=Yes&kerberos=True
Ceph Storage
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&prompt=[Prompt]&userName=[UserName]&password=[Password]&snmptelnetport=[PORT]&mode=[MODE OF MONITORING]&timeout=[TIMEOUT]
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 service you want to add. Value should be 'Ceph Storage'. |
| host | The name of the host in which the Ceph service is running. |
| username | The Ceph Storage service username. |
| password | The Ceph Storage service password. |
| prompt | The command prompt value - '$'. If you use # only v must use encode value of $23 |
| snmptelnetport | The port number where Telnet/SSH service is running. The default port for Telnet is 23 and SSH is 22. |
| mode | The Mode of Monitoring you want to use. Values can be Telnet or SSH. |
| timeout | The amount of time spent by Applications Manager to establish a connection with the server hosting the API service. The timeout value is 40 ms by default. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Ceph Storage&displayname=ceph&host=ctl-cephadmin&prompt=$&userName=admin&password=appman&snmptelnetport=22&mode=SSH&timeout=40
DNS Monitor
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&timeout=[TIMEOUT]&SearchField=[SEARCHFIELD]&TargetAddress=[TARGETADDRESS]&LookupAddress=[LOOKUPADDRESS]&RecordType=[RECORDTYPE]
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 |
|---|
| type | The type of the service you want to add. Value should be 'DNSMonitor'. |
| displayname | The display name of the host in which the monitor is running. |
| timeout | The timeout value in seconds. |
| SearchField | The value of SearchField. Options include None, Record Name, Address, Additional Name, Target, Admin, Host, Alias, Port and Priority. |
| SearchValue | The value to be checked in the selected record for the selected field. |
| TargetAddress | Host Name / IP Address to connect to the service |
| LookupAddress | The address you want to check in the DNS Server. |
| RecordType | The expected record type returned for the lookup address. The options include A, AAAA, CNAME, MX, NS, PTR, SOA, SPF, SRV and TXT. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=DNSMonitor&displayname=dnstttttt&timeout=15&SearchField=Record Name&TargetAddress=192.168.4.121&LookupAddress=appmanager.com&RecordType=A
FTP/SFTP Monitor
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&TargetAddress=[TARGETADDRESS]&DownloadFile=[DOWNLOADFILE]&IsSecured=[ISSECURED]&UploadFile=[UPLOADFILE]&RemoteSourceFileName=[REMOTESOURCEFILENAME]&RemoteDestinationFileName=[REMOTEDESTINATIONFILENAME]&LocalSourceFileName=[LOCALSOURCEFILENAME]&LocalDestinationFileName=[LOCALDESTINATIONFILENAME]&timeout=[TIMEOUT]
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 service you want to add. Value should be 'FTPMonitor'. |
| port | The port number where the FTP/SFTP service is running. |
| username | The FTP/SFTP user name. |
| password | The FTP/SFTP password. |
| TargetAddress | Host Name / IP Address to connect to the service. |
| DownloadFile | Indicates if download is enabled. Possible values include yes and no. If you would like to monitor the downloads (mget) through FTP/SFTP while simulateneously downloading the file, specify yes. |
| IsSecured | Specifies if the connection is secure or not. Value is either yes or no. |
| UploadFile | Indicates if upload file option is enabled. Values include yes and no. If you would like to upload a file to target address, specify yes. |
| RemoteSourceFileName | The Remote Source FileName located in the target address. This is applicable only if the value of 'DownloadFile' option is specified as yes. |
| RemoteDestinationFileName | The Remote Destination FileName located in the target address. This is applicable only if the value of 'UploadFile' option is specified as yes. |
| LocalSourceFileName | The name of the local source file with full path. The file must be available where Applications Manager instance is running. This is applicable only if the value of 'UploadFile' option is specified as yes. |
| LocalDestinationFileName | The local destination FileName with full path. The file will download in the given path where Applications Manager instance is running. This field is applicable only if the value of 'DownloadFile' option is specified as yes |
| timeout | The timeout value in seconds. |
| credentialID | ID for the credential to be used.
Note: Credential ID can be used as an alternative to username and password fields. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=FTPMonitor&displayname=ladpapitestooooo&port=22&username=admin&password=appman&TargetAddress=sprasadh&DownloadFile=no&IsSecured=yes&UploadFile=no&RemoteSourceFileName=&RemoteDestinationFileName=&LocalSourceFileName=&LocalDestinationFileName=&timeout=15
Hadoop Monitor
Note: NameNode and JobTracker / ResourceManager must be added using same Mode (JMX or RESTAPI).
Syntax
1. Add Hadoop monitor through REST API mode of monitoring (No Authentication and Simple Authentication):
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Hadoop&displayname=[DISPLAYNAME]&ModeOfMonitoring=RESTAPI&Version=[1.x/2.x]&NameNodeHost=[NAMENODE HOST]&NameNodeWebPort=[NAMENODE WEBPORT]&NameNodeSSLEnabled=[yes/no]&NameNodeWebAuthType=[SimpleAuth/NoAuth]&NameNodeUserName=[NAMENODE USERNAME]&JobTrackerHost=[JOBTRACKER HOSTNAME]&JobTrackerWebPort=[JOBTRACKER WEBPORT]&JobTrackerSSLEnabled=[yes/no}&JobTrackerWebAuthType=[SimpleAuth/NoAuth]&JobTrackerUserName=[JOBTRACKER USERNAME]
2. Add Hadoop monitor through REST API mode of monitoring (Kerberos Authentication):
http://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Hadoop&displayname=[DISPLAYNAME]&ModeOfMonitoring=RESTAPI&Version=2.x&NameNodeHost=[NAMENODE HOST]&NameNodeWebPort=[NAMENODE WEBPORT]&NameNodeSSLEnabled=[yes/no]&NameNodeWebAuthType=[NoAuth/SimpleAuth/KerberosAuth]&NameNodeUserName=&kdc=[KEY DISTRIBUTION CENTER]&NameNodeKeyTabPath=[NAMENODE KEYTAB LOCATION]&NameNodeSPN=[NAMENODE SPN]&JobTrackerHost=[JOBTRACKER/RESOURCE MANAGER HOST]&JobTrackerWebPort=[JOBTRACKER/RESOURCE MANAGER WEBPORT]&JobTrackerSSLEnabled=[yes/no]&JobTrackerWebAuthType=[NoAuth/SimpleAuth/KerberosAuth]&UserName=&JobTrackerKeyTabPath=[JOBTRACKER/RESOURCE MANAGER KEYTAB LOCATION]&JobTrackerSPN=[JOBTRACKER/RESOURCE MANAGER SPN]
3. Add Hadoop monitor through JMX mode of monitoring:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Hadoop&displayname=[DISPLAYNAME]&ModeOfMonitoring=JMX&Version=[1.x/2.x]&NameNodeHost=[NAMENODE HOST]&NameNodeJMXPort=[NAMENODE JMXPORT]&NameNodeUserName=[NAMENODE JMX USERNAME]&NameNodePassWord=[NAMENODE JMX PASSWORD]&NameNodeJNDIPath=[NAMENODE JNDIPATH]&JobTrackereHost=[JOBTRACKER HOSTNAME]&JobTrackerJMXPort=[JOBTRACKER JMXPORT]&JobTrackerUserName=[JOBTRACKER JMX USERNAME]&JObTrackerPassWord=[JOBTRACKER JMX PASSWORD]&JobTrackerJNDIPath=[JOBTRACKER JNDIPATH]
Request Parameters
The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.
| Field | Description |
|---|
| ModeOfMonitoring | The mode in which datacollection for Hadoop monitor will happen. Possible values: |
| Version | Version of Hadoop. Possible values: - 2.x (use this for Hadoop versions 2.x and above)
- 1.x
|
| NameNodeHost | HostName of Namenode. |
| NameNodeWebPort | Web port of Namenode. |
| NameNodeJMXPort | JMX Port of Namenode |
| NameNodeSSLEnabled | Is SSL enabled for Namenode webport? Possible values: |
| NameNodeWebAuthType | Type of authentication used by Namenode web. Possible values: - NoAuth
- SimpleAuth
- KerberosAuth
|
| NameNodeUserName | - Username of web access, if Simple Authentication is used in Namenode.
- Username of JMX access, if JMX mode of monitoring is chosen in Namenode.
|
| NameNodePassWord | Password for JMX access, if required for Namenode. |
| kdc | Key Distribution Center of Hadoop. |
| Namenode keytab location | Keytab location of the Namenode. |
| Namenode Service Principal Name | SPN of the Namenode. |
| NameNodeJNDIPath | JNDI path of the Namenode. |
| JobTrackerHost | HostName of Jobtracker. |
| JobTrackerWebPort | Web port of Jobtracker. |
| JobTrackerJMXPort | JMX Port of Jobtracker. |
| JobTrackerSSLEnabled | Is SSL enabled for Jobtracker webport? Possible values: |
| JobTrackerWebAuthType | Type of authentication used by Jobtracker web. Possible values: - NoAuth
- SimpleAuth
- KerberosAuth
|
| JobTrackerUserName | - Username of web access, if Simple Authentication is used in Jobtracker.
- Username of JMX access, if JMX mode of monitoring is chosen in Jobtracker.
|
| JobTrackerPassWord | Password for JMX access, if required for Jobtracker. |
| JobTracker/ResourceManager keytab location | Keytab location of the JobTracker/ResourceManager. |
| JobTracker/ResourceManager Service Principal Name | SPN of the JobTracker/ResourceManager. |
| JobTrackerJNDIPath | JNDI path of the Jobtracker. |
Sample Request
1. Add Hadoop monitor through REST API mode of monitoring (No Authentication and Simple Authentication):
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Hadoop&displayname=Hadoop&ModeOfMonitoring=RESTAPI&Version=1.x&NameNodeHost=naga-2385&NameNodeWebPort=50070&NameNodeSSLEnabled=no&NameNodeWebAuthType=SimpleAuth&NameNodeUserName=admin&JobTrackerHost=naga-2385&JobTrackerWebPort=50030&JobTrackerSSLEnabled=no&JobTrackerWebAuthType=SimpleAuth&JobTrackerUserName=jtadmin
2. Add Hadoop monitor through REST API mode of monitoring (Kerberos Authentication):
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Hadoop&displayname=Hadoop&ModeOfMonitoring=RESTAPI&Version=2.x&NameNodeHost=hadoop-namenode-1&NameNodeWebPort=50070&NameNodeSSLEnabled=no&NameNodeWebAuthType=KerberosAuth&NameNodeUserName=admin&kdc=hadoop-namenode-kdc.kerberos.com&NameNodeKeyTabPath=E:\AppManager17\working\conf\KerberosConfigurations\KeyTabs\hadoop-resman-1.keytab&NameNodeSPN=hdfs/hadoop-namenode-1.kerberos.com@APMKERBEROS.COM&JobTrackerHost=hadoop-resman-1&JobTrackerWebPort=50030&JobTrackerSSLEnabled=no&JobTrackerWebAuthType=KerberosAuth&JobTrackerUserName=jtadmin&JobTrackerKeyTabPath=E:\AppManager17\working\conf\KerberosConfigurations\KeyTabs\hadoop-resman-1.keytab&JobTrackerSPN=hdfs/hadoop-resman-1.kerberos.com@APMKERBEROS.COM
3. Add Hadoop monitor through JMX mode of monitoring:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Hadoop&displayname=Hadoop&ModeOfMonitoring=JMX&Version=1.x&NameNodeHost=naga-2385&NameNodeJMXPort=8004&NameNodeUserName=nnadmin&NameNodePassWord=nnappman&NameNodeJNDIPath=/jmxrmi&JobTrackerHost=naga-2385&JobTrackerJMXPort=8004&JobTrackerUserName=jtadmin&JobTrackerPassWord=jtappman&JobTrackerJNDIPath=/jmxrmi
Heartbeat Monitor
Note: Heartbeat Monitor works on a push-based model. The monitored service must send periodic pings to the generated heartbeat URL. The monitor status is updated only when data is received.
Syntax
1. Create a Heartbeat monitor using the AddMonitor REST API:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&pingName=[SERVICE_NAME]&criticalNoPingThreshold=[THRESHOLD_VALUE_IN_MINS]&warnNoPingThreshold=[THRESHOLD_VALUE_IN_MINS]&warnPingThreshold=[THRESHOLD_VALUE_IN_MINS]
2. Trigger a heartbeat ping (existing monitor):
https://[APM_HOST]:[APM_PORT]/heartbeat?pingName=[SERVICE_NAME]
(Include the authentication key in the POST body: apikey=[AUTH_KEY])
3. Bulk creation using Heartbeat Monitor API (auto-create on new pingName):
https://[APM_HOST]:[APM_PORT]/heartbeat?pingName=[SERVICE_NAME]
(Include the global Heartbeat Monitor API key in the POST body: apikey=[GLOBAL_API_KEY])
Request Parameters
The parameters involved in the AddMonitor API request are described below. Also, refer to the list of common Request Parameters.
| Field | Description |
|---|
| type | Type of monitor to be added. |
| displayname | Display name of the monitor. |
| pingName | Unique name used in the Ping URL. This value cannot be modified after creation. |
| criticalNoPingThreshold | Duration (in minutes) after which availability is marked as Critical if no ping is received. |
| warnNoPingThreshold | Duration (in minutes) after which health is marked as Critical if no ping is received. |
| warnPingThreshold | Duration (in minutes) to trigger a health alert if a ping is received unexpectedly within the defined interval. |
| apikey | API key used for authentication. |
Sample Request
1. Add Heartbeat monitor using AddMonitor API:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Heartbeat&displayname=Batch-Job-Heartbeat&pingName=BatchJob01&criticalNoPingThreshold=60&warnNoPingThreshold=10&warnPingThreshold=5
2. Trigger heartbeat using curl:
curl -k -X POST -d "apikey=xM4pxencla5pED229RxwQwu9yES7HlFY" "https://apm-prod-server:8334/heartbeat?pingName=BatchJob01"
3. Bulk creation example (auto-create monitors):
curl -k -X POST -d "apikey=xM4pxencla5pED229RxwQwu9yES7HlFY" "https://apm-prod-server:8334/heartbeat?pingName=Device01"
curl -k -X POST -d "apikey=xM4pxencla5pED229RxwQwu9yES7HlFY" "https://apm-prod-server:8334/heartbeat?pingName=Device02"
JMX Applications
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&jndiurl=[JNDIURL]
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 service you want to add. Value should be 'JMX Applications'. |
| host | The name of the host in which the monitor is running. |
| port | The port number where the RMI adapter is running. |
| jndiurl | The JNDI name. Example:/jmxrmi |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=JMX Applications&displayname=apmjmxapp&host=app-xp2&port=1099&jndiurl=/jmxrmi
LDAP Server
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&username=[USERNAME]&timeout=[TIMEOUT]&LDAPServer=[LDAPSERVER]&LDAPServerPort=[LDAPSERVERPORT]&MatchingAttribute=[MATCHINGATTRIBUTE]&FilterCondition=[FILTERCONDITION]&IsSecured=[ISSECURED]&SearchFilter=[SEARCHFILTER]&SearchResult=[SEARCHRESULT]&SearchBase=[SEARCHBASE]&password=[PASSWORD]
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 |
|---|
| type | The type of the service you want to add. Value should be 'LDAP Server'. |
| username | The user name of the LDAP server. |
| timeout | The timeout value in seconds. |
| LDAPServer | The name of the LDAP Server. |
| LDAPServerPort | The port at which the LDAP server is running. |
| MatchingAttribute | The matching attribute value. Values include cn, uid, sn, displayname, givenname, objectclass, dc and ou |
| FilterCondition | The value of filter condition. Values include equals, contains and notequals |
| IsSecured | Specifies if the connection is secure or not. Value is either yes or no. |
| SearchFilter | The value of Search Filter. This field is optional. |
| SearchResult | The string value that matches with search results. |
| SearchBase | The value of SearchBase. This is mandatory field when adding a LDAP monitor. |
| password | The password of the LDAP server. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=LDAP Server&displayname=ldap_serverqqqq&username=cn=admin,cn=users,dc=pmp,dc=com&timeout=10&LDAPServer=pmp-2k8s&LDAPServerPort=389&MatchingAttribute=cn&FilterCondition=equals&IsSecured=no&SearchFilter=&SearchResult=&SearchBase=&Password=appman
Ping Monitor/Ping Monitor (EUM)
Syntax
Ping Monitor:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Ping Monitor (Non EUM)&displayname=[DISPLAYNAME]&host=[HOST]&timeout=[TIMEOUT]
Ping Monitor (EUM):
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Ping Monitor&displayname=[DISPLAYNAME]&host=[HOST]&timeout=[TIMEOUT]&eumAgents=[AGENTNAME]&runOnServer=[RUNONSERVER]
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 |
|---|
| type | The type of the service you want to add. Value should either be Ping Monitor (Non EUM) or Ping Monitor. |
| displayname | Display name of the monitor. |
| host | The host in which the monitor is running. |
| timeout | The timeout value in seconds. |
| eumAgents | The display name(s) of the EUM agent(s), separated by comma. |
| runOnServer | Specifies whether the monitor has to be created in Applications Manager. (true or false) |
Sample Request
Ping Monitor:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Ping Monitor (Non EUM)&displayname=apmping&host=apm-host&timeout=5
Ping Monitor (EUM):
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Ping Monitor&displayname=apmping&host=apm-host&timeout=5&eumAgents=apm-eum-w7&runOnServer=true
Service Monitoring
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&timeout=[TIMEOUT]&command=[COMMAND]&search=[SEARCHSTRING]
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 service you want to add. Value should be Service Monitoring. |
| host | The name of the host in which the service is running. |
| timeout | The timeout value in seconds. |
| port | The port number in which the service is running. |
| displayname | The display name of the monitor. |
| command | The command to be executed after connecting to the service. |
| search | The string to be searched after executing the command. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Service Monitoring&displayname=apmservice&host=apm-host&port=9090&timeout=3&command=systemctl&search=error
SNMP/Network Device
Syntax
V1/V2
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&snmpCommunityString=[SNMPCOMMUNITYSTRING]&timeout=[TIMEOUT]&mode=SNMP
V3
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&snmpCommunityString=[SNMPCOMMUNITYSTRING]&timeout=[TIMEOUT]&mode=SNMP&snmpSecurityLevel=[SNMPSECURITYLEVEL]&snmpUserName=[SNMPUSERNAME]&snmpAuthPassword=[SNMPAUTHPASSWORD]&snmpAuthProtocol=[SNMPAUTHPROTOCOL]&snmpPrivPassword=[SNMPPRIVPASSWORD]&snmpPrivProtocol=[SNMPPRIVPROTOCOL]&snmpVersionValue=[SNMPVERSIONVALUE]&snmpContextName=[SNMPCONTEXTNAME]
Sample Request
V1/V2
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=4b5fd9cf3d9b2ca4aa5df62e7edefbec&type=SNMP/Network Device&displayname=apmsnmpdevicev1v2&host=apmsnmp-host-1&port=161&snmpCommunityString=public&timeout=5&mode=SNMP
V3
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=4b5fd9cf3d9b2ca4aa5df62e7edefbec&type=SNMP/Network Device&displayname=apmsnmpdevicev3&host=apmsnmp-host-1&port=161&timeout=5&snmpSecurityLevel=AUTHPRIV&snmpUserName=ApmMD5DESUser&snmpAuthPassword=**********&snmpAuthProtocol=MD5&snmpPrivPassword=**********&snmpPrivProtocol=DES&snmpVersionValue=v3&snmpContextName=&mode=SNMP
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 service you want to add. Value should be SNMP / Network Device. |
| host | The host in which the monitor is running. |
| port | The port number in which SNMP is running. |
| snmpCommunityString | The SNMP community string value. Default value is public. |
| timeout | The timeout value in seconds. |
| snmpVersionValue | The SNMP version to be used for access of SNMP data on the server. Mandatory when using SNMP mode. Possible values are v1v2 or v3. |
| mode | Discovery mode. Value is SNMP |
| snmpSecurityLevel | The SNMP V3 SecurityLevel. The value will be NOAUTHNOPRIV, AUTHNOPRIV, AUTHPRIV snmpUserName: The SNMP V3 Principal |
| snmpAuthProtocol | The SNMP V3 AuthProtocol |
| snmpAuthPassword | The SNMP V3 AuthPassword |
| snmpPrivProtocol | The SNMP V3 PrivProtocol |
| snmpPrivPassword | The SNMP V3 PrivPassword |
| snmpContextName | The SNMP V3 Context name |
Telnet / Telnet (EUM)
Syntax
Telnet:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Telnet&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&timeout=[TIMEOUT]
Telnet (EUM):
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Telnet (EUM)&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&timeout=[TIMEOUT]&eumAgents=[AGENTNAME]&runOnServer=[RUNONSERVER]
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 |
|---|
| type | The type of the service you want to add. Value should be Telnet or Telnet (EUM). |
| host | The name of the host in which the Telnet service is running. |
| timeout | The time out value in seconds. |
| port | The port number on which the Telnet service is running. |
| eumAgents | The display name(s) of the EUM agent(s), separated by comma. (Applicable only for Telnet (EUM) monitor) |
| runOnServer | Specifies whether the monitor has to be created in Applications Manager. (true or false) (Applicable only for Telnet (EUM) monitor) |
Sample Request
Telnet:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Telnet&displayname=apmtelnet&host=smrithil&port=23&timeout=2
Telnet (EUM):
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Telnet (EUM)&displayname=apmtelnet&host=smrithil&port=23&timeout=2&eumAgents=apm-eum-w7&runOnServer=true
Oracle Coherence
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[apikey]&type=Coherence&displayname=[Displayname]&HostName=[HostName]&Port=[Port]&PortAdd=[AdditionalPort]&UserName=[UserName]&Password=[Password]&JNDIPath=/jmxrmi
Request Parameters
The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.
| Field | Description |
|---|
| apikey | API key to create the Oracle Coherence monitor |
| type | The type of the database you want to add. Value should be Coherence. |
| displayname | Display name of the Oracle Coherence monitor |
| HostName | The name of the host in which Oracle coherence is running. |
| Port | The port number where Oracle Coherence is running. |
| PortAdd | Additional port of Oracle Coherence running in any machine. This is an optional field. |
| UserName | The name of the user who has permission to access the Oracle Coherence database. |
| Password | The password of the user who has permission to access the Oracle Coherence 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=Coherence&displayname=Coherence_API&HostName=it360-m4600-1&Port=1099&PortAdd=1095&UserName=admin&Password=appman&JNDIPath=/jmxrmi
Apache Zookeeper
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Zookeeper&displayname=Zookeeper&host=[Host Name]&port=[Port Number]&discoverclusternodes=[non mandatory column, if given the value should be 'Yes']&authReq=[non mandatory column, if given the value should be 'true']&username=[username]&password=[password]
Supported HTTP method: POST
Request Parameters
The parameters involved in the API request are described below.
| Field | Description |
|---|
| type | The type of the Service you want to add. Value should be Zookeeper. |
| host | The name of the host in which Zookeeper is running. |
| port | The port number where Zookeeper is running. |
| username | The name of the user who has permission to access the Zookeeper. |
| password | The password of the user who has permission to access the Zookeeper. |
| discoverclusternodes | Specifies if the Cluster Nodes must be discovered. Value can be YES/NO. This column is not mandatory. |
| authReq | Specifies if authentication is required. Value can be true/false. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Zookeeper&displayname=Zookeeper&host=172.20.7.36&port=7199&username=admin&password=appman
Apache Spark
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&ssl=[TRUE/FALSE]&DiscoverAllNodes=[YES/NO]
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 'Admin' tab. |
| type | The type of the monitor you want to add. Value should be ApacheSparkMaster. |
| displayname | The display name of the Apache Spark monitor. |
| host | The name of the host in which Apache Spark server is running. |
| port | The port number where Apache Spark server is running. |
| ssl | Specfies if SSL is enabled or not. Value can be either true or false. |
| DiscoverAllNodes | Specfies if you wish to discover all worker nodes. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=ApacheSparkMaster&displayname=Spark&host=172.20.7.36&port=7199&ssl=true&DiscoverAllNodes=yes
Istio
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAY NAME]&username=[USERNAME]&password=[PASSWORD]&namespace=[NAMESPACE]&Hostname=[HOSTNAME]&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 |
|---|
| apikey | The key generated from the Generate API Key option in the 'Admin' tab. |
| type | The type of the monitor you want to add. Value should be Istio. |
| displayname | The display name of the Istio monitor. |
| Hostname | The name of the host in which Istio server is running. |
| port | The port number where Istio server is running. |
| username | The username of the Istio server. |
| password | Password of the Istio server. |
| namespace | The namespace of the Istio server. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Istio&displayname=imasterrestapi&username=admin&password=appman&namespace=istio-system&Hostname=imaster&port=9922
Network Policy Server (Radius Server)
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=NetworkPolicyServer&displayname=[DISPLAYNAME]&host=[HOST]&UserName=[USERNAME]&Password=[PASSWORD]&Roles=[ROLES]&kerberos=[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 |
|---|
| apikey | The key generated from the Generate API Key option in the 'Admin' tab. |
| type | The type of the monitor you want to add. Value should be NetworkPolicyServer. |
| displayname | The display name of the Network Policy Server (Radius Server) monitor. |
| host | The name of the host in which Network Policy Server (Radius Server) is running. |
| UserName | The username of the Network Policy Server (Radius Server). |
| Password | Password of the Network Policy Server (Radius Server). |
| Roles | The roles of the Network Policy Server (Radius Server) separated by commas. Possible values are: |
| kerberos | Option to enable Kerberos authentication. (True or False) |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=NetworkPolicyServer&displayname=NPSAPI&host=183.51.13.6&UserName=APM\admin&Password=appman&Roles=RadiusServer,RadiusProxy&kerberos=False
UDP Port
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&timeout=[TIMEOUT]&command=[COMMAND]&search=[VALUE]
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 UDP Port. |
| host | The host name where the service is running. |
| port | The port number in which the service is running. |
| timeout | Time to wait for receiving response from server after executing the command. |
| command | Command to execute through the UDP port. Note: Only text format command type is supported. |
| search | Value to be searched in the server response after executing the command. For multiple values, place the values within square brackets, separated by a comma. eg : ["value1","value2","value3"] |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=UDP Port&displayname=UDP&host=localhost&port=13&timeout=5&command=test&search=["value"]
Hazelcast
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[apikey]&type=Hazelcast&displayname=[Displayname]&HostName=[HostName]&Port=[Port]&PortAdd=[AdditionalPort]&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 Hazelcast monitor. |
| type | The type of the database you want to add. Value should be Hazelcast. |
| displayname | Display name of the Hazelcast monitor. |
| HostName | The name of the host in which Hazelcast is running. |
| Port | The port number where Hazelcast is running. |
| PortAdd | Additional port of Hazelcast running in any machine. This is an optional field. |
| username | The name of the user who has permission to access the Hazelcast database. |
| password | The password of the user who has permission to access the Hazelcast 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=Hazelcast&displayname=Hcast&HostName=it360-m4600-1&Port=5000&PortAdd=1095&username=admin&password=appman&JNDIPath=/jmxrmi
