CA App Synthetic Monitor API 10.1.6.1/10.1.6.1 : rule_add

Add a new rule to an account

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).  
typeenum (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) *Protocol to test.  
modeenum (single, simultaneous)single Check mode. Single checkpoint per check, or multiple checkpoints simultaneously.  
hoststring (128) Hostname or IP address (v4/v6).  
portint TCP/UDP port to use. Defaults to the standard port of the protocol (type parameter).  
pathtext Path of the file to retrieve during the test.  
postmediumblob Content to POST (http/https) or upload.  
timeoutint8 Timeout in seconds. When the system under test does not respond within this time, the test is considered a FAIL.  
timewarnint2500  
timepoorint5000  
maxreadint Maximum number of bytes to retrieve. Not supported in all protocols, and is only used as a request.  
maxkibint1024 Maximum size of download, in kilobytes.  
accountstring (128) Account to identify the tester. Format depends on protocol. For HTTP domain\user can be used for MSFT authentication.  
passwdstring (1024) Password for authentication. Only used if the account parameter is present.  
parameterstext Additional parameters for the test.  
activebooleany Make this object active.  
intervaltime00:05:00 Interval, format HH:MM:SS.  
starttime00:00 Start time, format HH:MM:SS.  
endtime23:59 End time, format HH:MM:SS.  
daysstring0,1,2,3,4,5,6 List of weekdays. Comma separated list of digits 1-7, example: 1,2 is Monday and Tuesday.  
maint_startdatetime Start of maintenance, format YYYY-MM-DD HH:MM:SS.  
maint_durtime Maintenance duration, format HH:MM:SS. The maximum maintenance duration that you can specify is 23:59:59.  
maint_repeatenum (none, daily, weekly, monthly) Recurring period for maintenance.  
algorithmenum (random, master, excl, seq, sticky) Checkpoint selection algorithm.  
checklocchar (2) Checkpoint to use (deprecated).  
cpnsint0 Checkpoint (PoP) name space (deprecated).  
locpoolstring (400) Set of checkpoints to choose from (deprecated).  
folderstring (80) Name of folder of a monitor (empty string is top level folder).  
tagsstring (100) Tag names, comma separated list.  
alert_thresholdint5 Number of failed probes within a check required to trigger an alert. Only for simultaneous mode.  
colorstring (6) Color of the object. Format: 3 or 6 hex digits. Example 00FF00 is green.  
latfloat Latitude (geo).  
lngfloat Longitude (geo).  
uastring (255) User agent.  
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>
  <rid> unsigned int </rid>
</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