Reference Overview

This section is the source of truth for statusas 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; for learning paths, see the tutorials.

Monitors

How each monitor type runs checks and what you can configure on it.

• HTTP monitor — URL, method, headers, body, assertions, regions.
• TCP monitor — host:port checks for non-HTTP services.
• ICMP monitor — ping checks for host reachability, latency, and packet loss.
• gRPC monitor — health checks against the gRPC Health Checking Protocol.
• DNS monitor — record-type assertions for A, AAAA, CNAME, MX, NS, TXT.

Status pages

Public surfaces for communicating service health.

• Status page — page settings, custom domains, IP restrictions, themes, locales.
• Page components — monitor-linked and static components, component groups, ordering.
• Status report — incident updates and the state machine they drive.
• Maintenance — scheduled maintenance windows.
• Subscriber — email subscribers to a status page.

Alerting

• Notification channels — Slack, Discord, Microsoft Teams, Email, SMS, WhatsApp, Telegram, PagerDuty, OpsGenie, Google Chat, Grafana OnCall, Ntfy, and generic webhooks.
• Incident — auto-generated incident objects, trigger thresholds, and lifecycle states.

Probing infrastructure

• Location — every public region, its provider, and the IPv4/IPv6 addresses to allowlist.
• Private location — fields for a customer-deployed probe and the API surface that manages it.

Tooling

• CLI — every command, subcommand, and flag in the statusas CLI.
• Terraform provider — resource and data source schemas for statusas-lt/statusas.
• MCP server — tools and transport for the statusas Model Context Protocol server.

HTTP API

The HTTP API has its own dedicated documentation, generated from the OpenAPI schema:

• API reference (current) — the OpenAPI document, machine-readable, always up to date with the deployed server.
• API reference v1 (deprecated) — the legacy v1 surface; kept available for existing integrations.
• API rate limits — per-key and per-IP limits, the 429 response, and how to retry.