CLI Commands

Complete reference for all Watchplane CLI commands.

Global flags

These flags work with any command:

FlagDescription
--token <token>API token (overrides config)
--project-id <id>Project ID (overrides config)
--output <format>Output format: table, json, yaml
--base-url <url>API base URL (overrides config)
--helpShow help for any command

wp monitors

Manage uptime monitors.

wp monitors list

wp monitors list
wp monitors list --output json

wp monitors get <id>

wp monitors get mon_abc123

wp monitors create

wp monitors create \
  --name "API health" \
  --url https://api.example.com/health \
  --interval 60

Options:

FlagDescription
--nameMonitor name (required)
--urlURL to monitor (required)
--intervalCheck interval in seconds
--methodHTTP method (default: GET)

wp monitors update <id>

wp monitors update mon_abc123 --interval 30

wp monitors delete <id>

wp monitors delete mon_abc123

wp incidents

Manage incidents.

wp incidents list

wp incidents list
wp incidents list --output json

wp incidents ack <id>

Acknowledge an incident:

wp incidents ack inc_abc123

wp incidents resolve <id>

Resolve an incident:

wp incidents resolve inc_abc123

wp heartbeats

Manage heartbeat monitors.

wp heartbeats list

wp heartbeats list

wp heartbeats create

wp heartbeats create \
  --name "Nightly backup" \
  --interval 86400 \
  --grace-period 3600

wp heartbeats delete <id>

wp heartbeats delete hb_abc123

wp webhooks

Manage webhook integrations.

wp webhooks list

wp webhooks list

wp webhooks create

wp webhooks create \
  --name "My hook" \
  --url https://example.com/hook \
  --events monitor.down,monitor.up

wp webhooks test <id>

Send a test event:

wp webhooks test wh_abc123

wp webhooks delete <id>

wp webhooks delete wh_abc123

wp status-pages

Manage status pages.

wp status-pages list

wp status-pages list

wp status-pages create

wp status-pages create --name "Production Status"

wp projects

Manage projects.

wp projects list

wp projects list

wp projects create

wp projects create --name "Production"

wp config

Manage CLI configuration.

wp config set

wp config set --token wp_abc123 --project-id proj_abc

wp config get

wp config get

wp whoami

Show the currently authenticated user:

wp whoami

Output:

Email:    you@example.com
Name:     Your Name
Org:      Acme Inc
Plan:     Pro
Documentation