]> git.immae.eu Git - github/fretlink/terraform-provider-statuscake.git/blob - index.html.markdown
website/docs: Run `terraform fmt` on code examples (#12075)
[github/fretlink/terraform-provider-statuscake.git] / index.html.markdown
1 ---
2 layout: "statuscake"
3 page_title: "Provider: StatusCake"
4 sidebar_current: "docs-statuscake-index"
5 description: |-
6 The StatusCake provider configures tests in StatusCake.
7 ---
8
9 # StatusCake Provider
10
11 The StatusCake provider allows Terraform to create and configure tests in [StatusCake](https://www.statuscake.com/). StatusCake is a tool that helps to
12 monitor the uptime of your service via a network of monitoring centers throughout the world
13
14 The provider configuration block accepts the following arguments:
15
16 * ``username`` - (Required) The username for the statuscake account. May alternatively be set via the
17 ``STATUSCAKE_USERNAME`` environment variable.
18
19 * ``apikey`` - (Required) The API auth token to use when making requests. May alternatively
20 be set via the ``STATUSCAKE_APIKEY`` environment variable.
21
22 Use the navigation to the left to read about the available resources.
23
24 ## Example Usage
25
26 ```
27 provider "statuscake" {
28 username = "testuser"
29 apikey = "12345ddfnakn"
30 }
31
32 resource "statuscake_test" "google" {
33 website_name = "google.com"
34 website_url = "www.google.com"
35 test_type = "HTTP"
36 check_rate = 300
37 contact_id = 12345
38 }
39 ```