Heartbeats (CLI)

Manage heartbeat checks for background jobs and cron tasks from the obs CLI. Create, update, pause, mute, reset, and delete.

Manage heartbeat checks (for monitoring background jobs or cron tasks).

obs heartbeat create --name "Daily Backup" --period 86400 --grace 3600
obs heartbeat list
obs heartbeat get <id>
obs heartbeat update <id> --period 43200
obs heartbeat runs <id> --limit 10  # Recent pings
obs heartbeat toggle <id>           # Pause or resume execution
obs heartbeat toggle-muted <id>     # Mute or unmute alerts without pausing
obs heartbeat reset <id>            # Reset the heartbeat timer
obs heartbeat delete <id> -y

See also: the CLI reference overview.

Was this page helpful?