Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/openstatusHQ/openstatus. 🫖 Status page with uptime monitoring & API monitoring as code 🫖 openstatus.dev
bun drizzle-orm monitoring monitoring-as-code nextjs observability on-call open-source shadcn-ui status-page statuspage synthetic-monitoring tinybird turso uptime uptime-checker uptime-monitor
Something went wrong. Try again.
MDX
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152---category: Referencetitle: Reference Overviewdescription: "Technical specifications for openstatus monitors, status pages, notifications, locations, and the CLI, MCP, and Terraform integrations."---
This section is the source of truth for openstatus configuration. Use it to look up exact field names, types, defaults, and behaviour — not to learn how to do something. For task-oriented walkthroughs, see the [how-to guides](/docs/guides/getting-started); for learning paths, see the [tutorials](/docs/tutorial/getting-started).
## Monitors
How each monitor type runs checks and what you can configure on it.
- **[HTTP monitor](/docs/reference/http-monitor)** — URL, method, headers, body, assertions, regions.- **[TCP monitor](/docs/reference/tcp-monitor)** — host:port checks for non-HTTP services.- **[ICMP monitor](/docs/reference/icmp-monitor)** — ping checks for host reachability, latency, and packet loss.- **[gRPC monitor](/docs/reference/grpc-monitor)** — health checks against the gRPC Health Checking Protocol.- **[DNS monitor](/docs/reference/dns-monitor)** — record-type assertions for A, AAAA, CNAME, MX, NS, TXT.
## Status pages
Public surfaces for communicating service health.
- **[Status page](/docs/reference/status-page)** — page settings, custom domains, IP restrictions, themes, locales.- **[Page components](/docs/reference/page-components)** — monitor-linked and static components, component groups, ordering.- **[Status report](/docs/reference/status-report)** — incident updates and the state machine they drive.- **[Maintenance](/docs/reference/maintenance)** — scheduled maintenance windows.- **[Subscriber](/docs/reference/subscriber)** — email subscribers to a status page.
## Alerting
- **[Notification channels](/docs/reference/notification)** — Slack, Discord, Microsoft Teams, Email, WhatsApp, Telegram, PagerDuty, OpsGenie, Google Chat, Grafana OnCall, Ntfy, and generic webhooks.- **[Incident](/docs/reference/incident)** — auto-generated incident objects, trigger thresholds, and lifecycle states.
## Probing infrastructure
- **[Location](/docs/reference/location)** — every public region, its provider, and the IPv4/IPv6 addresses to allowlist.- **[Private location](/docs/reference/private-location)** — fields for a customer-deployed probe and the API surface that manages it.
## Tooling
- **[CLI](/docs/reference/cli-reference)** — every command, subcommand, and flag in the `openstatus` CLI.- **[Terraform provider](/docs/reference/terraform)** — resource and data source schemas for `openstatusHQ/openstatus`.- **[MCP server](/docs/reference/mcp-server)** — tools and transport for the openstatus Model Context Protocol server.
## HTTP API
The HTTP API has its own dedicated documentation, generated from the OpenAPI schema:
- **[API reference (current)](https://api.openstatus.dev/openapi)** — the OpenAPI document, machine-readable, always up to date with the deployed server.- **[API reference v1 (deprecated)](https://api.openstatus.dev/v1)** — the legacy v1 surface; kept available for existing integrations.- **[API rate limits](/docs/reference/api-rate-limits)** — per-key and per-IP limits, the `429` response, and how to retry.