Getting started with the UptimeRobot CLI
The UptimeRobot CLI is the official command-line interface for UptimeRobot. Create and manage monitors, incidents, status pages, maintenance windows, and alert contacts from your terminal, scripts, CI pipelines, or an AI coding agent. It's built on UptimeRobot API v3, showing readable tables when you work interactively and stable JSON when you automate.
Before you start
Node.js 22.12 or newer — check with
node --version, download from nodejs.org.An UptimeRobot API key — create one at dashboard.uptimerobot.com/integrations. See How to use UptimeRobot's API if this is your first key.
1. Install
npm install --global @uptimerobot/cli
uptimerobot --version
2. Log in
uptimerobot auth login
You'll be prompted for your API key with masked input, and it's stored in your operating system's secure credential store — so the key never lands in your shell history.
In CI, containers, and other temporary environments, pass the key through the environment instead:
export UPTIMEROBOT_API_KEY='your-api-key'
3. Run your first commands
# List your monitors
uptimerobot monitors list
# Create an HTTP monitor
uptimerobot monitors create http \
--name checkout-api \
--url https://checkout.example.com \
--interval 60 \
--timeout 30
# Check recent incidents
uptimerobot incidents list
Destructive commands ask for confirmation in a terminal; in scripts, pass --confirm:
uptimerobot monitors delete 797054213 --confirm
Finding your way around
Help is available at every level of the command tree and lists required fields, accepted values, defaults, and examples:
uptimerobot help
uptimerobot monitors --help
uptimerobot monitors create keyword --help
Command groups: monitors, incidents, status-pages, maintenance-windows, alert-contacts, integrations, monitor-groups, tags, user, and auth.
Full documentation
The package README on npm covers everything else in detail, including:
All authentication options and where credentials are stored
Output formats (
--json,jsonl,table,plain,--raw) and automation defaultsFiltering, pagination, and column selection
Sending full API request bodies with
--bodyValidating requests locally with
monitors schemaand--dry-runRetry and safety behavior for automation and agents
Getting help
For bugs and feature requests, open an issue on GitHub. Include the CLI version, the command you ran, and the error output with sensitive values removed — never share your API key.