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 | /.well-known/cloud/v1 | machine-only cloud-discovery document for the request host’s registrable domain (SHC-866), read by an onboarding client that has no account yet and never by an operator, so no client method is generated. Public and unauthenticated by format, because the document has to say how to authenticate before anything can authenticate, and NOT the API envelope: a bare {version, domain, providers, services} object served as application/json with Cache-Control: no-cache. The body is rendered by the ingress reconcile, so the handler is a lookup: 404 on a cold daemon until the first sweep lands, and on any host this estate does not serve | annotation |
GET | /.well-known/cloud/v1/ca/{file} | machine-only PEM of the trust anchor a cloud-discovery device_login names (FZ-8668): the CA a joined computer pins for LDAPS, fetched by the installer before any sign-in, so no client method is generated. Public material served as application/x-pem-file; 404 for a sha no published device_login names on the request host’s registrable domain | annotation |
GET | /.well-known/shc/v1 | machine-only SHC document for the request host’s registrable domain (FZ-9759, based docs/cloud-discovery.md 3.8): where the SHC app finds the Console, read before it signs in, so no client method is generated. Public and unauthenticated by format, and NOT the API envelope: a bare {console, tenant} object served as application/json with Cache-Control: no-cache, console the Console’s https origin and tenant present only when the domain’s deployments sit in one tenant. Rendered by the ingress reconcile beside the cloud-discovery document, so 404 on a cold daemon, on a headless estate and on any host this estate does not serve | annotation |
GET | /api/health | map[string]any | handler |
GET | /api/method/shc.app.detail | MethodResponse[AppDetailResponse] | handler |
GET | /api/method/shc.app.icon | catalog icon file bytes (image/png/image/svg+xml/… per the packaged file’s extension; self-authenticating, because <img> tags fetch it; 404 when the app has no packaged icon) | annotation |
POST | /api/method/shc.app.upload | MethodResponse[AppUpload] | handler |
GET | /api/method/shc.cert.delivery | MethodResponse[CertDeliveryMessage] | handler |
GET | /api/method/shc.cert.edge | MethodResponse[CertEdgeMessage] | handler |
POST | /api/method/shc.cluster.confirm_restore | MethodResponse[any] | handler |
POST | /api/method/shc.cluster.host_set | MethodResponse[ClusterHostChange] | handler |
GET | /api/method/shc.cluster.host_show | MethodResponse[ClusterHostShowMessage] | handler |
GET | /api/method/shc.ingress.cat | MethodResponse[IngressCatMessage] | handler |
GET | /api/method/shc.ingress.ls | MethodResponse[IngressLsMessage] | handler |
GET | /api/method/shc.integration.graph | MethodResponse[DocResponse[Graph]] | handler |
GET | /api/method/shc.integration.list | MethodResponse[DocResponse[[]IntegrationStateRow]] | handler |
POST | /api/method/shc.integration.provision | MethodResponse[IntegrationProvision] | handler |
GET | /api/method/shc.operation.list | MethodResponse[OperationListMessage] | handler |
GET | /api/method/shc.plug.list | MethodResponse[DocResponse[[]PlugRow]] | 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.repoint | MethodResponse[RepointPlan] | 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.stack.update_plan | MethodResponse[UpdatePlan] | handler |
POST | /api/method/shc.stack.update_rollback | MethodResponse[UpdateRollbackResult] | handler |
GET | /api/method/shc.stack.usage | MethodResponse[StackUsageResponse] | 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.openobserve_reset_admin_password | MethodResponse[SystemOpenObserveAdminPasswordResetResult] | handler |
POST | /api/method/shc.system.plan | MethodResponse[SystemPlanResponse] | handler |
GET | /api/method/shc.system.ready | MethodResponse[{ready}] | handler |
GET | /api/resource/App | ListResponse[AppResponse] | handler |
GET | /api/resource/App/{name} | DocResponse[AppResponse] | handler |
GET | /api/resource/Deployment | ListResponse[StackResponse] | handler |
DELETE | /api/resource/Deployment/{name} | AsyncOperationResponse | handler |
GET | /api/resource/Deployment/{name} | DocResponse[StackResponse] | handler |
GET | /api/resource/Environment | ListResponse[CoordinateResponse] | handler |
GET | /api/resource/Stack | ListResponse[CoordinateResponse] | handler |
GET | /api/status | map[string]any | handler |
POST | /api/telemetry | {ok}, the fixed literal {"ok": true} acknowledgement | annotation |
shc@docs:~$