CA App Synthetic Monitor API 10.1.6.1/10.1.6.1 : rule_log

Retrieve probe(s) from one account. Filter by specifying rule, folder, tags, date range, and/or name.

price: 1 api 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.  
acctstring Account e-mail. If left empty, then the request is on behalf of the account that is logged in (nkey).  
namestring (80) Name of monitor (rule).  
folderstring Name of folder of a monitor (empty string is top level folder).  
tagsstring Tag names, comma separated list.  
tags_reqenum (any, all)any  
errorsonlybooleann  
formatenum (xml, csv, xls, tab, stream, json)xml Output format for this call.  
reversebooleann Reverse order in output of this call.  
fullbooleann Return full log entry.  
legacy_outputbooleany Output field in deprecated format.  
start_datedate Starting date, format YYYY-MM-DD.  
end_datedate End date, format YYYY-MM-DD.  
cursorunsigned int Return results relative to last cursor returned.  
uuidstring  
numunsigned int50 Number of results to return.  
sourceunsigned int Filter results by source location. Only applicable when 'name' is also specified..  
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.  

Result:

<result>
  <probes>
    <probe>
      <name> string (80) </name>
      <rid> unsigned int </rid>
      <deleted> boolean </deleted>
      <start> datetime </start>
      <end> datetime </end>
      <repeat> unsigned int </repeat>
      <result> unsigned int </result>
      <type> unsigned int </type>
      <descr> string </descr>
      <ttime> unsigned int </ttime>
      <rtime> unsigned int </rtime>
      <ctime> unsigned int </ctime>
      <ptime> unsigned int </ptime>
      <dtime> unsigned int </dtime>
      <dsize> unsigned int </dsize>
      <loc> string </loc>
      <source> unsigned int </source>
      <alerts> unsigned int </alerts>
      <id> unsigned int </id>
      <uuid> string </uuid>
      <output> string </output>
      <ipaddr> string </ipaddr>
    </probe>
    ...
  </probes>
  <cursor> unsigned int </cursor>
</result>
(presence of output fields depends on input parameters)

Error codes:

codedescription
0okay
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