Skip to content
SHC Docs

Node API

  • router → prefix /api/resource/Node (tags: Node)
  • method_router → prefix /api/method

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

The shc.node.ls / shc.node.status list/status method routes are served by the cluster module, not here.

MethodPathPermission
GET/api/resource/Nodetenant:read
GET/api/resource/Node/{name}tenant:read

GET /api/resource/Node and /{name} answer a caller below platform with each node’s id, health_status, health_checked_at and availability only; every other field is empty (SHC-924 ruling).

The resource surface is read-only. Node membership is created by the enrollment path (shc node join, see cluster) and removed by shc.cluster.rm / shc.cluster.forget; there is no POST/PUT/DELETE /api/resource/Node.

MethodPathPermission
GET/api/method/shc.node.deploymentsplatform:manage
POST/api/method/shc.node.healthplatform:manage