aboutsummaryrefslogtreecommitdiffhomepage
path: root/index.html.markdown
blob: 150b36aad1f01bdf2a485322338c54f3fbef57ed (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
---
layout: "statuscake"
page_title: "Provider: StatusCake"
sidebar_current: "docs-statuscake-index"
description: |-
  The StatusCake provider configures tests in StatusCake.
---

# StatusCake Provider

The StatusCake provider allows Terraform to create and configure tests in [StatusCake](https://www.statuscake.com/). StatusCake is a tool that helps to
monitor the uptime of your service via a network of monitoring centers throughout the world

The provider configuration block accepts the following arguments:

* ``username`` - (Required) The username for the statuscake account. May alternatively be set via the
  ``STATUSCAKE_USERNAME`` environment variable.

* ``apikey`` - (Required) The API auth token to use when making requests. May alternatively
  be set via the ``STATUSCAKE_APIKEY`` environment variable.
  
Use the navigation to the left to read about the available resources.

## Example Usage

```
provider "statuscake" {
    username = "testuser"
    apikey = "12345ddfnakn"
}

resource "statuscake_test" "google" {
    website_name = "google.com"
    website_url = "www.google.com"
    test_type = "HTTP"
    check_rate = 300
}
```