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/App
GET/api/resource/App/{name}
MethodPathPermission
GET/api/resource/Stack
DELETE/api/resource/Stack/{name}
GET/api/resource/Stack/{name}
MethodPathPermission
GET/api/method/shc.app.detail
GET/api/method/shc.preset.search
GET/api/method/shc.integration.list
GET/api/method/shc.plug.list
GET/api/method/shc.socket.list
GET/api/method/shc.stack.status
POST/api/method/shc.stack.install
POST/api/method/shc.stack.uninstall
POST/api/method/shc.stack.update
POST/api/method/shc.stack.scale
POST/api/method/shc.system.plan
POST/api/method/shc.system.complete
  • summary: full detail for a single catalog app.
  • query params: app, version, runtime
  • source: modules/app/router.go
  • summary: search app-shipped variable presets.
  • query params: app, q, category, limit
  • source: modules/app/router.go
  • query params: stack_name (alias: name, which wins when both are sent), 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.