The obs CLI manages your monitoring resources from the terminal. This reference is split by resource type. Pick a page below for the full command set, flags, and examples.

For installation and login see Getting started. For declarative export and apply see Config-as-code.

Command reference by resource#

Monitors: basic HTTP ping monitors.
API Checks: API health checks with headers and assertions.
Heartbeats: checks for background jobs and cron tasks.
Alert Channels: notification destinations.
Status Pages: public or private status pages and monitor attachments.
Incidents: incident records.
Autopilot Suites: AI-generated Playwright suites and CI bindings.
API Keys & Teams: programmatic keys and team membership.

Resource discovery#

Enumerate resource templates and fetch their JSON schemas (offline, no API call).

obs templates list                # List all resource types with required fields
obs templates list --json
obs schema monitor                # Print JSON Schema (Draft-07) for a resource
obs schema alert-channel --out ./schemas/alert-channel.schema.json
obs validate -r monitor -f ./my-monitor.json   # Offline schema validation

obs templates list                # List all resource types with required fields
obs templates list --json
obs schema monitor                # Print JSON Schema (Draft-07) for a resource
obs schema alert-channel --out ./schemas/alert-channel.schema.json
obs validate -r monitor -f ./my-monitor.json   # Offline schema validation

obs validate checks required fields, field types, and enum values (for example a bad method or priority) against the resource schema, with no API call.

Aliases: api-check resolves to check, url-monitor to monitor.