Skip to content
SHC Docs

HUD API

Routers

Section titled “Routers”
  • router → prefix /api/method (tags: hud)

Hand-maintained notes. The exec proxy is registered by the shell module (modules/shell/router.go); the HUD stream by sysroutes (modules/sysroutes/router.go). Route inventory (generated): routes.md / routes.md. Response models (generated): response-models/shell.md / response-models/sysroutes.md.

MethodPathPermission
WS/api/method/shc.container.exec—
WS/api/method/shc.hud.stream—

WS /api/method/shc.container.exec

Section titled “WS /api/method/shc.container.exec”

Proxy interactive exec to the internal API’s ws-exec endpoint.

WS /api/method/shc.hud.stream

Section titled “WS /api/method/shc.hud.stream”

Stream HUD snapshots to connected clients.

On connect the cache ref count is incremented (starting the polling loop if this is the first client). Each time the cache produces a new snapshot the filtered result is pushed to the client as JSON.

The client may send {"action": "refresh"} to trigger an immediate out-of-band poll.