# CLI Reference

Source: https://www.observeone.com/docs/cli/reference

- [Docs](/docs)
- [CLI](/docs/cli)
- CLI Reference

# CLI Reference

Copy Markdown

Overview of the obs CLI command reference. Discover resource schemas, then jump to per-resource command pages for monitors, API checks, heartbeats, alert channels, status pages, incidents, and suites.

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](/docs/cli/getting-started). For declarative export and apply see [Config-as-code](/docs/cli/config-as-code).

## Command reference by resource[#](#command-reference-by-resource)

- [Monitors](/docs/cli/monitors): basic HTTP ping monitors.

- [API Checks](/docs/cli/api-checks): API health checks with headers and assertions.

- [Heartbeats](/docs/cli/heartbeats): checks for background jobs and cron tasks.

- [Alert Channels](/docs/cli/alert-channels): notification destinations.

- [Status Pages](/docs/cli/status-pages): public or private status pages and monitor attachments.

- [Incidents](/docs/cli/incidents): incident records.

- [Autopilot Suites](/docs/cli/suites): AI-generated Playwright suites and CI bindings.

- [API Keys & Teams](/docs/cli/api-keys): programmatic keys and team membership.

## Resource discovery[#](#resource-discovery)

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

Copy

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.

Was this page helpful?
