| parameter | value | 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). |
| 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) | * | Protocol to test. |
| mode | | enum (single, simultaneous) | single | Check mode. Single checkpoint per check, or multiple checkpoints simultaneously. |
| host | | string (128) | | Hostname or IP address (v4/v6). |
| port | | int | | TCP/UDP port to use. Defaults to the standard port of the protocol (type parameter). |
| path | | text | | Path of the file to retrieve during the test. |
| post | | mediumblob | | Content to POST (http/https) or upload. |
| timeout | | int | 8 | Timeout in seconds. When the system under test does not respond within this time, the test is considered a FAIL. |
| maxread | | int | | Maximum number of bytes to retrieve. Not supported in all protocols, and is only used as a request. |
| maxkib | | int | 1024 | Maximum size of download, in kilobytes. |
| account | | string (128) | | Account to identify the tester. Format depends on protocol. For HTTP domain\user can be used for MSFT authentication. |
| passwd | | string (1024) | | Password for authentication. Only used if the account parameter is present. |
| parameters | | text | | Additional parameters for the test. |
| active | | boolean | y | Make this object active. |
| interval | | time | 00:05:00 | Interval, format HH:MM:SS. |
| start | | time | 00:00 | Start time, format HH:MM:SS. |
| end | | time | 23:59 | End time, format HH:MM:SS. |
| days | | string | 0,1,2,3,4,5,6 | List of weekdays. Comma separated list of digits 1-7, example: 1,2 is Monday and Tuesday. |
| maint_start | | datetime | | Start of maintenance, format YYYY-MM-DD HH:MM:SS. |
| maint_dur | | time | | Maintenance duration, format HH:MM:SS. The maximum maintenance duration that you can specify is 23:59:59. |
| maint_repeat | | enum (none, daily, weekly, monthly) | | Recurring period for maintenance. |
| algorithm | | enum (random, master, excl, seq, sticky) | | Checkpoint selection algorithm. |
| checkloc | | char (2) | | Checkpoint to use (deprecated). |
| cpns | | int | 0 | Checkpoint (PoP) name space (deprecated). |
| locpool | | string (400) | | Set of checkpoints to choose from (deprecated). |
| folder | | string (30) | | Name of folder of a monitor (empty string is top level folder). |
| tags | | string (100) | | Tag names, comma separated list. |
| alert_threshold | | int | 5 | Number of failed probes within a check required to trigger an alert. Only for simultaneous mode. |
| color | | string (6) | | Color of the object. Format: 3 or 6 hex digits. Example 00FF00 is green. |
| lat | | float | | Latitude (geo). |
| lng | | float | | Longitude (geo). |
| ua | | string (255) | | User agent. |
| 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. |