app response models
Generated file — do not edit by hand. Regenerate from the repo root with
CGO_ENABLED=0 go run scripts/gen-response-models-md.go.
Part of the API response model reference, which explains the Response model and Origin columns. Route inventory: routes.md. Named payload structs: payload-shapes.md.
| Method | Path | Response model | Origin |
|---|---|---|---|
GET | /api/health | map[string]any | handler |
GET | /api/method/shc.app.detail | AppDetailResponse | handler |
GET | /api/method/shc.integration.list | MethodResponse[DocResponse[[]IntegrationStateRow]] | handler |
GET | /api/method/shc.plug.list | MethodResponse[DocResponse[[]PlugRow]] | handler |
GET | /api/method/shc.preset.search | MethodResponse[[]CLIPresetHit] | handler |
GET | /api/method/shc.socket.list | MethodResponse[DocResponse[[]SocketRow]] | handler |
POST | /api/method/shc.stack.install | AsyncOperationResponse | handler |
POST | /api/method/shc.stack.lease_clear | MethodResponse[{cleared}] | handler |
POST | /api/method/shc.stack.lease_renew | MethodResponse[leaseResponse] | handler |
GET | /api/method/shc.stack.lease_show | MethodResponse[leaseResponse] | handler |
POST | /api/method/shc.stack.protect | MethodResponse[protectResponse] | handler |
GET | /api/method/shc.stack.protect_show | MethodResponse[protectResponse] | handler |
POST | /api/method/shc.stack.scale | MethodResponse[ScaleResult] | handler |
GET | /api/method/shc.stack.services | MethodResponse[StackServicesResponse] | handler |
GET | /api/method/shc.stack.status | MethodResponse[StackResponse] | handler |
POST | /api/method/shc.stack.uninstall | AsyncOperationResponse | handler |
POST | /api/method/shc.stack.unprotect | MethodResponse[protectResponse] | handler |
POST | /api/method/shc.stack.update | AsyncOperationResponse | handler |
POST | /api/method/shc.system.complete | MethodResponse[SystemPlanResponse] | handler |
POST | /api/method/shc.system.keycloak_reset_admin_password | MethodResponse[SystemKeycloakAdminPasswordResetResult] | handler |
POST | /api/method/shc.system.plan | MethodResponse[SystemPlanResponse] | handler |
GET | /api/resource/App | ListResponse[AppResponse] | handler |
GET | /api/resource/App/{name} | DocResponse[AppResponse] | handler |
GET | /api/resource/Stack | ListResponse[StackResponse] | handler |
DELETE | /api/resource/Stack/{name} | AsyncOperationResponse | handler |
GET | /api/resource/Stack/{name} | DocResponse[StackResponse] | handler |
GET | /api/status | map[string]any | handler |
POST | /api/telemetry | {ok} — fixed literal {"ok": true} acknowledgement | annotation |
shc@docs:~$