Skip to content
SHC Docs

stack module

  • 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, or update a deployment live in the app module (shc.stack.install, shc.stack.uninstall, shc.stack.update, shc.stack.status); replicas change through shc.stack.update’s scale_overrides. Log streaming (shc.stack.logs.stream) lives in the logs module. Relocate is shc.stack.relocate in the clone module.

MethodPathPermission
GET/api/method/shc.stack.configstack:manage
GET/api/method/shc.stack.dry_runstack:manage
GET/api/method/shc.stack.inspectstack:manage
GET/api/method/shc.stack.logsstack:read
POST/api/method/shc.stack.execstack:manage
POST/api/method/shc.stack.restartstack:operate
POST/api/method/shc.stack.startstack:operate
POST/api/method/shc.stack.stopstack:operate
POST/api/method/shc.container.restartopen

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 on the node that carries the deployment’s three shc.* labels, whatever compose project made it (replica projects included), with Health enriched from the metrics stats cache; health_rollup summarises containers[].Health as healthy / starting / unhealthy / unknown / "".