Skip to content
SHC Docs

App API

  • router → prefix /api/resource/App (tags: App)
  • stack_router → prefix /api/resource/Stack (tags: Stack)
  • method_router → prefix /api/method
  • infra routes: /api/health, /api/status, /api/telemetry

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

Not in this module: shc.stack.config / exec / inspect / logs / dry_run / container.restart are served by the stack module; shc.stack.logs.stream by the logs module; shc.stack.move by the clone module.

MethodPathPermission
GET/api/resource/Appopen
GET/api/resource/App/{name}open
MethodPathPermission
GET/api/resource/Stackstack:read
MethodPathPermission
GET/api/method/shc.app.detailstack:read
GET/api/method/shc.integration.liststack:read
GET/api/method/shc.plug.liststack:read
GET/api/method/shc.socket.liststack:read
GET/api/method/shc.stack.statusstack:read
POST/api/method/shc.stack.installstack:manage
POST/api/method/shc.stack.uninstallstack:manage
POST/api/method/shc.stack.updatestack:manage
POST/api/method/shc.system.planopen
POST/api/method/shc.system.completeopen
  • summary: full detail for a single catalog app.
  • query params: app, version, runtime
  • source: modules/app/router.go
  • query params: stack_name (name is refused with X400132STKQRY), environment, tenant_name
  • source: modules/app/router.go

Liveness / status / telemetry endpoints registered by this module:

MethodPathPurpose
GET/api/healthLiveness probe.
GET/api/statusDaemon status snapshot.
POST/api/telemetryIngest client telemetry.