Monitors (CLI)

Manage basic HTTP ping monitors from the obs CLI. Create, list, update, run, pause, mute, and delete URL monitors.

Manage basic HTTP ping monitors.

obs monitor create --name "Frontend" --url "https://example.com" --interval "*/5 * * * *" \
--description "Production landing" \
--alert-channel-id 12 --alert-channel-id 47
obs monitor list
obs monitor get <id>
obs monitor update <id> --description "Updated copy" --alert-channel-id 47
obs monitor runs <id> --limit 10 # Recent executions
obs monitor run <id> # Trigger a manual run
obs monitor toggle <id> # Pause or resume execution
obs monitor toggle-muted <id> # Mute or unmute alerts without pausing
obs monitor delete <id> -y

Flags: -d, --description, --alert-channel-id <id> (repeatable), --no-alerts.

Environments#

A monitor can be bound to a project and environment from the dashboard. At run time, {{KEY}} tokens in the url field resolve from that environment's variables and secrets, for manual and scheduled runs alike. Resolution happens server-side only: the stored monitor keeps the raw {{KEY}} template, and results show the token rather than the resolved secret value.

For example, a monitor with url set to https://{{API_HOST}}/health resolves {{API_HOST}} from the bound environment before each run.

See also: Collections & Environments for how environments work, and API Checks for header- and assertion-based checks, and the CLI reference overview.

Was this page helpful?