Ping API


This API will be used to ping the given server or the server corresponding to the given monitor's resourceid. The ping command will be executed and the result will be passed as response of the request.

Syntax

API for XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/Ping?apikey=[ API Key ]&resourceid='10000157'

API for JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/Ping?apikey=[ API Key ]&host='hemachand-0591'

Request Parameters

Field Description
resourceid This value specifies the resourceid of the monitor, So that we can ping host corresponding to monitor.
host This is the host of any server which can be passed as parameter to ping from the Applications Manager server.

Response Parameters

Field Description
APIKey This is the username.
Description This is the description of the user account given at the time of creation of user account
EmailID This is the e-mail id of the user
GroupName This is the typ of account the user has. ex: operator, admin, manager etc.,
UserImage This is User image path
UserID This is the ID of the user
UserName This is the username of the user.

Sample Request

XML Input:

http://prod-server:9090/AppManager/xml/Ping?apikey=apikey=c4e547c2330e2eb92d3e7af2262da9e9&resourceid='10000157'

XML Response:

<AppManager-response uri="/AppManager/xml/Ping">
<result>
<response response-code="4000">
<PingResult Output="Pinging 127.0.0.1 with 32 bytes of data:<br>Reply from 127.0.0.1: bytes=32 time<1ms TTL=128<br><br>Ping statistics for 127.0.0.1:<br> Packets: Sent = 1, Received = 1, Lost = 0 (0% loss),<br>Approximate round trip times in milli-seconds:<br> Minimum = 0ms, Maximum = 0ms, Average = 0ms<br>" Host="127.0.0.1" IPAddress="127.0.0.1"/>
</response>
</result>
</AppManager-response>

JSON Input:

http://apm-prod1:9090/AppManager/json/Ping?apikey=c4e547c2330e2eb92d3e7af2262da9e9&host=apm-prod1

JSON Response:

{"response-code":"4000","response":{"uri":"/AppManager/json/Ping","result":[{"Output":"Pinging apm-prod1.csez.zohocorpin.com [fe80::51a4:f642:390a:7e1f%14] with 32 bytes of data:<br>Reply from fe80::51a4:f642:390a:7e1f%14: time<1ms <br><br>Ping statistics for fe80::51a4:f642:390a:7e1f%14:<br> Packets: Sent = 1, Received = 1, Lost = 0 (0% loss),<br>Approximate round trip times in milli-seconds:<br> Minimum = 0ms, Maximum = 0ms, Average = 0ms<br>","Host":"apm-prod1.csez.zohocorpin.com","IPAddress":"192.168.26.79"}]}}