App API
Routers
Section titled “Routers”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.restartare served by thestackmodule;shc.stack.logs.streamby thelogsmodule;shc.stack.moveby theclonemodule.
Router router
Section titled “Router router”| Method | Path | Permission |
|---|---|---|
GET | /api/resource/App | — |
GET | /api/resource/App/{name} | — |
GET /api/resource/App
Section titled “GET /api/resource/App”- source:
modules/app/router.go
GET /api/resource/App/{name}
Section titled “GET /api/resource/App/{name}”- source:
modules/app/router.go
Router stack_router
Section titled “Router stack_router”| Method | Path | Permission |
|---|---|---|
GET | /api/resource/Stack | — |
DELETE | /api/resource/Stack/{name} | — |
GET | /api/resource/Stack/{name} | — |
GET /api/resource/Stack
Section titled “GET /api/resource/Stack”- source:
modules/app/router.go
DELETE /api/resource/Stack/{name}
Section titled “DELETE /api/resource/Stack/{name}”- source:
modules/app/router.go
GET /api/resource/Stack/{name}
Section titled “GET /api/resource/Stack/{name}”- source:
modules/app/router.go
Router method_router
Section titled “Router method_router”| Method | Path | Permission |
|---|---|---|
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 | — |
GET /api/method/shc.app.detail
Section titled “GET /api/method/shc.app.detail”- summary: full detail for a single catalog app.
- query params:
app,version,runtime - source:
modules/app/router.go
GET /api/method/shc.preset.search
Section titled “GET /api/method/shc.preset.search”- summary: search app-shipped variable presets.
- query params:
app,q,category,limit - source:
modules/app/router.go
GET /api/method/shc.integration.list
Section titled “GET /api/method/shc.integration.list”- source:
modules/app/router.go
GET /api/method/shc.plug.list
Section titled “GET /api/method/shc.plug.list”- source:
modules/app/router.go
GET /api/method/shc.socket.list
Section titled “GET /api/method/shc.socket.list”- source:
modules/app/router.go
GET /api/method/shc.stack.status
Section titled “GET /api/method/shc.stack.status”- query params:
stack_name(alias:name, which wins when both are sent),environment,tenant_name - source:
modules/app/router.go
POST /api/method/shc.stack.install
Section titled “POST /api/method/shc.stack.install”- async accept — returns an
operation_id; follow progress viaGET /api/method/shc.operation.stream/{operation_id}(see SSE streaming). - source:
modules/app/router.go
POST /api/method/shc.stack.uninstall
Section titled “POST /api/method/shc.stack.uninstall”- source:
modules/app/router.go
POST /api/method/shc.stack.update
Section titled “POST /api/method/shc.stack.update”- source:
modules/app/router.go
POST /api/method/shc.stack.scale
Section titled “POST /api/method/shc.stack.scale”- source:
modules/app/router.go
POST /api/method/shc.system.plan
Section titled “POST /api/method/shc.system.plan”- summary: compute the daemon-authoritative system-app install plan.
- source:
modules/app/router.go
POST /api/method/shc.system.complete
Section titled “POST /api/method/shc.system.complete”- summary: finalize a system-app initialization step.
- source:
modules/app/router.go
Infra routes
Section titled “Infra routes”Liveness / status / telemetry endpoints registered by this module:
| Method | Path | Purpose |
|---|---|---|
GET | /api/health | Liveness probe. |
GET | /api/status | Daemon status snapshot. |
POST | /api/telemetry | Ingest client telemetry. |
shc@docs:~$