Documentation Index
Fetch the complete documentation index at: https://docs.devhelm.io/llms.txt
Use this file to discover all available pages before exploring further.
Manage monitors from the command line. Create, update, delete, pause, resume, and run on-demand checks.
Commands
| Command | Description |
|---|
devhelm monitors list | List all monitors |
devhelm monitors get <id> | Get monitor details |
devhelm monitors create | Create 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.
| Flag | Type | Default | Description |
|---|
--page-size | integer | 200 | Number of items per API request (1–200) |
monitors get
Get detailed information about a single monitor.
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
| Flag | Type | Required | Description |
|---|
--name | string | Yes | Human-readable name for this monitor |
--type | string | Yes | Monitor type: HTTP, DNS, TCP, ICMP, HEARTBEAT, MCP_SERVER |
--url | string | — | Target URL or host |
--frequency | string | — | Check frequency in seconds (default: 60) |
--method | string | — | HTTP method: GET, POST, PUT, PATCH, DELETE, HEAD |
--port | string | — | TCP port to connect to |
--regions | string | — | Comma-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
| Flag | Type | Description |
|---|
--name | string | New monitor name |
--url | string | New target URL or host |
--frequency | string | New check frequency in seconds |
--method | string | New HTTP method |
--port | string | New 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.
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
| Flag | Type | Default | Description |
|---|
--limit | integer | 20 | Maximum 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
| Flag | Type | Default | Description |
|---|
--limit | integer | 20 | Maximum number of versions to show |
monitors versions get
Get a specific configuration version.
devhelm monitors versions get 42 3
Next steps
Monitoring overview
Understanding monitor types, regions, and assertions.
Config as Code
Deploy monitors from YAML configuration files.
