AddMonitor APIs - EUM Monitors
This section explains how to use the AddMonitor API to add monitors of the category type End User Monitoring (EUM). The following monitors are supported:
Supported HTTP methods: POST
Allowed roles: Administrator
The following parameters are common in API requests for EUM monitors:
| Field | Description |
|---|
| eumAgents | The display name(s) of the EUM agent(s). If there are multiple entries, they can be comma separated. |
| eumAgentsId | The unique ID of the EUM agents configured. These can be specified as comma separated. |
| runOnServer | Specifies if the monitor has to be created in Applications Manager. Possible values are true or false. |
Note: It is not mandatory to use both 'eumAgents' and 'eumAgentsId' parameters in the same API request. You can use either one of these.
Ping
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&timeout=[TIMEOUT]&eumAgents=[EUMAGENTS]&eumAgentsId=[EUMAGENTID]&runOnServer=[RUNONSERVER]
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 'Ping Monitor'. |
| host | The host in which the monitor is running. |
| timeout | The timeout value in seconds. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Ping Monitor&displayname=apmping&host=smrithil&timeout=5&eumAgents=eumflorida&runOnServer=true
DNS
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&timeout=[TIMEOUT]&TargetAddress=[TARGETADDRESS]&LookupAddress=[LOOKUPADDRESS]&RecordType=[RECORDTYPE]&SearchField=[SEARCHFIELD]&SearchValue=[SEARCHVALUE]&eumAgents=[EUMAGENTS]&eumAgentsId=[EUMAGENTID]&runOnServer=[RUNONSERVER]
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 '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. |
| TargetAddress | The DNS Server host name or IP address. |
| 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. |
| SearchValue | 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&TargetAddress=192.168.4.121&LookupAddress=appmanager.com&RecordType=A&SearchField=Record Name&SearchValue=appmanager.com&eumAgents=eumbe1&runOnServer=true
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]&eumAgents=[EUMAGENTS]&eumAgentsId=[EUMAGENTID]&runOnServer=[RUNONSERVER]
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 'LDAP Server'. |
| username | The user name of the LDAP server. |
| timeout | The timeout value in seconds. |
| LDAPServer | The Hostname or IP Address of 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. This field is optional. |
| SearchBase | The value of SearchBase. This is mandatory field when adding a LDAP monitor. |
| password | The password of the LDAP server. |
| 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=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=dc=matrix,dc=lab&Password=appman&eumAgents=eumbe1&runOnServer=true
Mail Server
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&host=[HOST]&port=[PORT]&displayname=[DISPLAYNAME]&emailid=[EMAILID]&timeout=[TIMEOUT]&authRequired=[AUTHREQUIRED]&sslEnabled=[SSLENABLED]&username=[USERNAME]&password=[PASSWORD]&tlsEnabled=[TLSENABLED]&pollinterval=[POLLINTERVAL]&mailsubject=[MAILSUBJECT]&fetchEnabled=[FETCHENABLED]&fetchType=[FETCHTYPE]&fsHost=[FSHOST]&fsport=[FSPORT]&fsSSLEnabled=[FSSSLENABLED]&fsTLSEnabled=[FSTLSENABLED]&fsUserName=[FSUSERNAME]&fsPassword=[FSPASSWORD]&eumAgents=[EUMAGENTS]&eumAgentsId=[EUMAGENTID]&runOnServer=[RUNONSERVER]
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 'Mail Server'. |
| host | The SMTP host name |
| port | The port at which SMTP is running. |
| emailid | The email address to which the mail will be sent. |
| timeout | The timeout value in seconds. |
| authRequired | Indicates if the SMTP requires authentication. Values are 'Yes' or 'No' |
| sslEnabled | Indicates if the SMTP host should be accessed through SSL. Values are 'Yes' or 'No' |
| username | The username of the SMTP host |
| password | The password of the SMTP host |
| tlsEnabled | Denotes whether TLS should be used for SMTP. Values are true or false. |
| pollinterval | The polling interval of the monitor in seconds. |
| mailSubject | The message to appear in the subject of the email. |
| fetchEnabled | Indicates if the POP/IMAP server should be monitored. Values are 'Yes' or 'No'. |
| fetchType | Indicates the service that is monitored. If you want to add POP type, specify the value as 1. If you want to monitor IMAP server, specify the value as 2. |
| fsHost | The host name of the POP/IMAP server |
| fsport | The port at which the POP/IMAP server is running. |
| fsSSLEnabled | Indicates whether the POP/IMAP server is SSL enabled or not. Values are Yes or No. |
| fsTLSEnabled | Indicates whether TLS should be used for POP/IMAP. Values are true or false. |
| fsUserName | The user name of the POP/IMAP server. |
| fsPassword | The password of the POP/IMAP server |
| 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=Mail Server&host=smtp1&port=25&displayname=apmsmtp&emailid=admin@yourdomain.com&timeout=5&authRequired=Yes&sslEnabled=Yes&username=admin&password=appman&tlsEnabled=true&pollinterval=60&mailsubject=Testing Mail Server&fetchEnabled=Yes&fetchType=1&fsHost=POP1&fsport=110&fsSSLEnabled=Yes&fsTLSEnabled=true&fsUserName=fsadmin&fsPassword=fsappman&eumAgents=eum1&runOnServer=true
Telnet
Syntax
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 to the list of common request parameters.
| Field | Description |
|---|
| type | The type of the service you want to add. Value should be Telnet (EUM). |
| host | The host name or IP address in which the telnet service is running. |
| timeout | The time out value in seconds. |
| port | The port number in which Telnet is running. |
| 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
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Telnet (EUM)&displayname=apmtelnet&host=smrithil&port=23&timeout=2&eumAgents=apm-eum-server&runOnServer=true
