Skip to content
SHC Docs

Stack API

  • router → prefix /api/method (tags: stack)

Hand-maintained notes against modules/stack/router.go. Route inventory (generated): routes.md. Response models (generated): response-models/stack.md.

Lifecycle verbs that install / uninstall / update / scale a stack live in the app module (shc.stack.install, shc.stack.uninstall, shc.stack.update, shc.stack.scale, shc.stack.status). Log streaming (shc.stack.logs.stream) lives in the logs module; shc.stack.move lives in the clone module.

MethodPathPermission
GET/api/method/shc.stack.config
GET/api/method/shc.stack.dry_run
GET/api/method/shc.stack.inspect
GET/api/method/shc.stack.logs
POST/api/method/shc.stack.exec
POST/api/method/shc.stack.restart
POST/api/method/shc.stack.start
POST/api/method/shc.stack.stop
POST/api/method/shc.container.restart

StackInspectResponse is a one-shot bundle covering everything the HUD’s Inspect panel and the shc inspect CLI need without follow-up calls. Field inventory (generated): response-models/payload-shapes.md. Semantics the generated table can’t carry: composed_config is the parsed docker compose config --format json output, best-effort with a 5s timeout (absent when compose can’t resolve); containers holds one entry per container under the compose project label with Health enriched from the metrics stats cache; health_rollup summarises containers[].Health as healthy / starting / unhealthy / unknown / "".