Web Dashboard

vminfo --web starts a lightweight, read-only HTTP API and dashboard.

Start the server

vminfo --web

Default address:

http://127.0.0.1:20021

Custom address:

vminfo --web --bind 0.0.0.0 --port 8080 --interval 1s

You can also launch the TUI alongside the dashboard:

vminfo --web --tui

Authentication

By default, the dashboard and API are local and unauthenticated.

When --token is enabled:

vminfo --web --token
vminfo --web --token my-secret

• bare --token auto-generates a URL-safe token
• --token my-secret uses a fixed token
• the first successful /?token=... visit sets a cookie for later requests
• /healthz remains public for local probes
• /, /api/v1/*, and /ws require the token or auth cookie
• token-protected mode does not expose permissive Access-Control-Allow-Origin: *
• WebSocket upgrades require the browser origin to match the dashboard host

Remote access

When binding to 0.0.0.0, enable --token unless the dashboard is only exposed to a trusted private network.

Endpoints

Endpoint	Purpose
GET /healthz	Public health check
GET /api/v1/snapshot	Full runtime snapshot
GET /api/v1/cpu	CPU data
GET /api/v1/memory	Memory and swap data
GET /api/v1/disk	Filesystem and disk I/O data
GET /api/v1/network	Network totals and interface data
GET /api/v1/processes	Process list
GET /api/v1/system	Host metadata
GET /api/v1/health	Health score and warnings
GET /ws	Live snapshot stream

See the full HTTP API reference for payload examples and query parameters.