CA App Synthetic Monitor API 2022.8.3/2022.8.3 : cp_ping

Perform a PING check

price: 1 check credit

<<back to index

parametervaluetypedefault / required*notes
nkeytoken Session key or token. Automatically assigned (only if optional) or obtained via acct_login/acct_token call.  
checklocstring Checkpoint to use (deprecated).  
cpnsint0 Checkpoint (PoP) name space (deprecated).  
sourcestring (255) Checkpoint group to use (replaces checkloc and cpns).  
hoststring (128) *Hostname or IP address (v4/v6).  
ipversionint IP version 4 or 6. Default try 6 then 4.  
countunsigned int1 Number of ping probes to send (max 10).  
timeoutunsigned int Timeout in seconds. When the system under test does not respond within this time, the test is considered a FAIL.  
detailboolean Obsolete, ignored.  
dummyunsigned int Dummy parameter to make the REST call unique and prevent caching.  
callbackstring Callback function for JSONP style calls. When this parameter is given, the result will be JSON instead of XML.  
viewenum (xml, json)xml Specifies the desirable representation of the output (XML or JSON). HTTP Accept header can be used and has precedence.  


  <status> unsigned int </status>
  <loc> string </loc>
  <locode> string </locode>
  <cpns> unsigned int </cpns>
  <message> string </message>
  <final> unsigned int </final>
  <rtime> unsigned int </rtime>
  <ttime> unsigned int </ttime>
  <dtime> unsigned int </dtime>
  <dsize> unsigned int </dsize>
  <cp_id> string </cp_id>
  <source> unsigned int </source>
  <alias> string </alias>
  <cp_city> string </cp_city>
  <cp_country> string </cp_country>
  <cp_botaddr> string </cp_botaddr>
  <cp_botaddr6> string </cp_botaddr6>
  <cp_lat> string </cp_lat>
  <cp_lng> string </cp_lng>
  <ip> string </ip>
  <lat> float </lat>
  <lng> float </lng>
  <version> string </version>
    <loss> real </loss>
      <icmp_seq> unsigned int </icmp_seq>
      <ip> string </ip>
      <time> unsigned int </time>
(presence of output fields depends on input parameters)

Error codes:

1000authentication error
1001call syntax error
1002undefined name or id
1003account limit exceeded
1004database error
1005duplicate entry
1006upgrade account
1007not yours (anymore)
1008session expired
1009insufficient credits
1010messaging error
1011undefined result
1012cannot perform that operation
1013illegal parameter value
1014TOS restriction
1015unconfirmed address
1016contact helpdesk first
9999unsupported feature
1017value not allowed

<<back to index