Protocol Monitors (CLI)

Manage SSL, TCP, UDP, and database monitors. Each has the same surface as url monitors: CRUD plus run, runs, toggle, toggle-muted.

obs ssl-monitor create --name "cert" --hostname example.com --port 443 --warn-days 14
obs tcp-monitor create --name "PG" --host db.example.com --port 5432 --expect-banner "..."
obs udp-monitor create --name "DNS" --host 1.1.1.1 --port 53 --expect-response
obs db-monitor create --name "PG" --host db.example.com --port 5432 --protocol postgres --tls

obs ssl-monitor create --name "cert" --hostname example.com --port 443 --warn-days 14
obs tcp-monitor create --name "PG" --host db.example.com --port 5432 --expect-banner "..."
obs udp-monitor create --name "DNS" --host 1.1.1.1 --port 53 --expect-response
obs db-monitor create --name "PG" --host db.example.com --port 5432 --protocol postgres --tls

Commands and aliases: obs ssl-monitor (ssl), obs tcp-monitor (tcp), obs udp-monitor (udp), obs db-monitor (db).

Type-specific flags:

Common flags (all four): -n, --name, -d, --description, -i, --interval (cron), --timeout <ms>, --region <region> (repeatable), --retry-count <n>, --retry-interval <seconds>, --team-id <id>, --alert-channel-id <id> (repeatable), --no-alerts.

obs ssl-monitor list
obs ssl-monitor get <id>
obs ssl-monitor runs <id> --limit 10   # Recent executions
obs ssl-monitor run <id>               # Trigger a manual run
obs ssl-monitor toggle <id>            # Pause or resume execution
obs ssl-monitor toggle-muted <id>      # Mute or unmute alerts without pausing
obs ssl-monitor delete <id> -y

obs ssl-monitor list
obs ssl-monitor get <id>
obs ssl-monitor runs <id> --limit 10   # Recent executions
obs ssl-monitor run <id>               # Trigger a manual run
obs ssl-monitor toggle <id>            # Pause or resume execution
obs ssl-monitor toggle-muted <id>      # Mute or unmute alerts without pausing
obs ssl-monitor delete <id> -y

Every type also supports --file <path> create and obs schema <type> for the JSON Schema (Draft-07) definition, matching obs monitor and obs check.

Environments#

Each of these monitor types can be bound to a project and environment from the dashboard, the same as url monitors. {{KEY}} tokens resolve from the bound environment's variables and secrets at run time, on manual and scheduled runs alike, in these fields per type:

Resolution happens server-side only: the stored monitor keeps the raw {{KEY}} template, and results show the token rather than the resolved secret value.

See also: Monitors for basic HTTP ping monitors, and the CLI reference overview.