CA App Synthetic Monitor API 24.7.7/24.7.7 : rule_get

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

price: 1 api credit

parameter	type	default / required*	notes
nkey	token	*	Session key or token. Automatically assigned (only if optional) or obtained via acct_login/acct_token call.
acct	string		Account e-mail. If left empty, then the request is on behalf of the account that is logged in (nkey).
name	string (80)		Name of monitor (rule).
folder	string		Name of folder of a monitor (empty string is top level folder).
tags	string		Tag names, comma separated list.
tags_req	enum (any, all)	any
errorsonly	boolean	n
publiconly	boolean	n
dummy	unsigned int		Dummy parameter to make the REST call unique and prevent caching.
callback	string		Callback function for JSONP style calls. When this parameter is given, the result will be JSON instead of XML.
view	enum (xml, json)	xml	Specifies the desirable representation of the output (XML or JSON). HTTP Accept header can be used and has precedence.

Result:

<result>
  <maximum> unsigned int </maximum>
  <active> unsigned int </active>
  <rules>
    <rule>
      <name> string (80) </name>
      <rid> unsigned int </rid>
      <folder> string </folder>
      <fid> unsigned int </fid>
      <active> boolean </active>
      <tags> string </tags>
      <lastcheck> datetime </lastcheck>
      <consecutive_errors> unsigned int </consecutive_errors>
      <errorsince> datetime </errorsince>
      <interval> time </interval>
      <type> enum (connect, ping, http, pop3, smtp, imap, gopher, ftp, telnet, script, scriptxl, scriptxxl, plugin, dnsa, dnsns, https, ftps, tftp, scp, sftp, sip, dns, domain, ldap, trace, browser, whois, browserscript, script_chrome, script_ie, script_firefox, tmpl_jmeter, tmpl_browser, se, webdriver, websocket, tls) </type>
      <host> string (128) </host>
      <port> int </port>
      <path> text </path>
      <post> mediumblob </post>
      <maxread> int </maxread>
      <account> string (128) </account>
      <passwd> string (1024) </passwd>
      <parameters> text </parameters>
      <options> string (4096) </options>
      <ua> string (255) </ua>
      <start> time </start>
      <end> time </end>
      <days> string </days>
      <maint_start>  </maint_start>
      <maint_dur>  </maint_dur>
      <maint_repeat>  </maint_repeat>
      <contact> string </contact>
      <skip> unsigned int </skip>
      <notifyon> boolean </notifyon>
      <algorithm> enum (random, master, excl, seq, sticky) </algorithm>
      <cpns> int </cpns>
      <checkloc> char (2) </checkloc>
      <locpool> string (400) </locpool>
      <timeout> int </timeout>
      <timewarn> int </timewarn>
      <timepoor> int </timepoor>
      <color> string (6) </color>
      <lat> float </lat>
      <lng> float </lng>
      <entered> timestamp </entered>
    </rule>
    ...
  </rules>
</result>

(presence of output fields depends on input parameters)

Error codes:

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

<<back to index