aboutsummaryrefslogtreecommitdiffhomepage
path: root/website/docs
diff options
context:
space:
mode:
Diffstat (limited to 'website/docs')
-rw-r--r--website/docs/r/test.html.markdown21
1 files changed, 20 insertions, 1 deletions
diff --git a/website/docs/r/test.html.markdown b/website/docs/r/test.html.markdown
index 0a1df9f..a385b00 100644
--- a/website/docs/r/test.html.markdown
+++ b/website/docs/r/test.html.markdown
@@ -36,7 +36,26 @@ The following arguments are supported:
36* `confirmations` - (Optional) The number of confirmation servers to use in order to detect downtime. Defaults to 0. 36* `confirmations` - (Optional) The number of confirmation servers to use in order to detect downtime. Defaults to 0.
37* `port` - (Optional) The port to use when specifying a TCP test. 37* `port` - (Optional) The port to use when specifying a TCP test.
38* `trigger_rate` - (Optional) The number of minutes to wait before sending an alert. Default is `5`. 38* `trigger_rate` - (Optional) The number of minutes to wait before sending an alert. Default is `5`.
39 39* `custom_header` - (Optional) Custom HTTP header, must be supplied as JSON.
40* `user_agent` - (Optional) Test with a custom user agent set.
41* `node_locations` - (Optional) Set test node locations, must be array of strings.
42* `ping_url` - (Optional) A URL to ping if a site goes down.
43* `basic_user` - (Optional) A Basic Auth User account to use to login
44* `basic_pass` - (Optional) If BasicUser is set then this should be the password for the BasicUser.
45* `public` - (Optional) Set 1 to enable public reporting, 0 to disable.
46* `logo_image` - (Optional) A URL to a image to use for public reporting.
47* `branding` - (Optional) Set to 0 to use branding (default) or 1 to disable public reporting branding).
48* `website_host` - (Optional) Used internally, when possible please add.
49* `virus` - (Optional) Enable virus checking or not. 1 to enable
50* `find_string` - (Optional) A string that should either be found or not found.
51* `do_not_find` - (Optional) If the above string should be found to trigger a alert. 1 = will trigger if find_string found.
52* `real_browser` - (Optional) Use 1 to TURN OFF real browser testing.
53* `test_tags` - (Optional) Tags should be seperated by a comma - no spacing between tags (this,is,a set,of,tags).
54* `status_codes` - (Optional) Comma Seperated List of StatusCodes to Trigger Error on. Defaults are "204, 205, 206, 303, 400, 401, 403, 404, 405, 406, 408, 410, 413, 444, 429, 494, 495, 496, 499, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511, 521, 522, 523, 524, 520, 598, 599".
55* `use_jar` - (Optional) Set to true to enable the Cookie Jar. Required for some redirects. Default is false.
56* `post_raw` - (Optional) Use to populate the RAW POST data field on the test.
57* `final_endpoint` - (Optional) Use to specify the expected Final URL in the testing process.
58* `follow_redirect` - (Optional) Use to specify whether redirects should be followed, set to true to enable. Default is false.
40 59
41## Attributes Reference 60## Attributes Reference
42 61