Terraform

Manage monitors, notifications, and status pages as HCL — same plan-and-apply lifecycle as the rest of your infrastructure, with one command to bootstrap from an existing workspace.

The openstatus Terraform provider treats monitoring as code: monitors, notifications, and status pages live in the same plan-and-apply lifecycle as the rest of your infrastructure.

Quickstart

terraform {
  required_providers {
    openstatus = {
      source = "openstatusHQ/openstatus"
    }
  }
}

resource "openstatus_monitor" "api" {
  name      = "API"
  url       = "https://api.example.com/health"
  frequency = "1m"
  regions   = ["iad", "ams", "syd"]
}

export OPENSTATUS_API_TOKEN=os_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
terraform init
terraform plan
terraform apply

What you can do

• Manage every primary entity — monitors, notification channels, status pages, subscribers, maintenance windows — through HCL.
• Roll changes out alongside the rest of your infrastructure (Vercel projects, DNS records, secrets).
• Bootstrap an HCL file from your existing workspace with openstatus terraform generate — no hand-writing required.
• Code-review monitor changes in the same PR that adds the service being monitored.

Bootstrap from an existing workspace

If you already have monitors and status pages in the dashboard, the CLI generates HCL for you:

openstatus terraform generate

The output is a valid HCL configuration with cross-references between resources and import blocks pre-wired so terraform plan shows zero drift on first run.

Auth & audit

Set OPENSTATUS_API_TOKEN before running Terraform. The token is the same one the CLI, API, and MCP server share — generate it from Settings → API Tokens.

Every mutation through the provider lands in the audit log under actor_type = 'api', so you can trace any change back to a key, a user, and a transport.

Other surfaces

• Prefer a YAML config in your repo? See the CLI and openstatus monitors apply.
• Building an in-app integration? Call the API directly.
• Want Claude or ChatGPT to read or update status reports? See the MCP server.

Reference

Full resource list and schema in the Terraform reference.

Frequently asked questions