Skip to main content
Manage monitors from the command line. Create, update, delete, pause, resume, and run on-demand checks.

Commands

CommandDescription
devhelm monitors listList all monitors
devhelm monitors get <id>Get monitor details
devhelm monitors createCreate a monitor
devhelm monitors update <id>Update a monitor
devhelm monitors delete <id>Delete a monitor
devhelm monitors pause <id>Pause a monitor
devhelm monitors resume <id>Resume a paused monitor
devhelm monitors test <id>Run an on-demand check
devhelm monitors results <id>Show recent check results
devhelm monitors versions list <id>List monitor config versions
devhelm monitors versions get <id> <version>Get a specific config version

monitors list

List all monitors in your organization.
devhelm monitors list
FlagTypeDefaultDescription
--page-sizeinteger200Number of items per API request (1–200)

monitors get

Get detailed information about a single monitor.
devhelm monitors get 42
devhelm monitors get 42 -o json

monitors create

Create a new monitor.
devhelm monitors create \
  --name "API Health" \
  --type HTTP \
  --url https://api.example.com/health \
  --frequency 60 \
  --regions us-east,eu-west
FlagTypeRequiredDescription
--namestringYesHuman-readable name for this monitor
--typestringYesMonitor type: HTTP, DNS, TCP, ICMP, HEARTBEAT, MCP_SERVER
--urlstringTarget URL or host
--frequencystringCheck frequency in seconds (default: 60)
--methodstringHTTP method: GET, POST, PUT, PATCH, DELETE, HEAD
--portstringTCP port to connect to
--regionsstringComma-separated probe regions

Examples by type

devhelm monitors create \
  --name "API Health" \
  --type HTTP \
  --url https://api.example.com/health \
  --method GET \
  --frequency 60 \
  --regions us-east,eu-west

monitors update

Update an existing monitor’s configuration.
devhelm monitors update 42 \
  --name "API Health (v2)" \
  --frequency 30
FlagTypeDescription
--namestringNew monitor name
--urlstringNew target URL or host
--frequencystringNew check frequency in seconds
--methodstringNew HTTP method
--portstringNew TCP port

monitors delete

Delete a monitor. This also removes all associated check results.
devhelm monitors delete 42

monitors pause

Temporarily stop a monitor from running checks. The monitor retains its configuration and can be resumed at any time.
devhelm monitors pause 42

monitors resume

Resume a paused monitor.
devhelm monitors resume 42

monitors test

Run an on-demand check immediately, without waiting for the next scheduled interval.
devhelm monitors test 42
The result is printed to stdout. Use -o json for structured output:
devhelm monitors test 42 -o json

monitors results

Show recent check results for a monitor.
devhelm monitors results 42
FlagTypeDefaultDescription
--limitinteger20Maximum number of results to show (1–1000)
devhelm monitors results 42 --limit 5 -o json

monitors versions list

List configuration versions for a monitor. Each update to a monitor creates a new version.
devhelm monitors versions list 42
FlagTypeDefaultDescription
--limitinteger20Maximum number of versions to show

monitors versions get

Get a specific configuration version.
devhelm monitors versions get 42 3
The first argument is the monitor ID, the second is the version number.

Next steps

Monitoring overview

Understanding monitor types, regions, and assertions.

Config as Code

Deploy monitors from YAML configuration files.