Node API
Routers
Section titled “Routers”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.statuslist/status method routes are served by theclustermodule, not here.
Router router
Section titled “Router router”| Method | Path | Permission |
|---|---|---|
GET | /api/resource/Node | tenant: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, seecluster) and removed byshc.cluster.rm/shc.cluster.forget; there is noPOST/PUT/DELETE /api/resource/Node.
GET /api/resource/Node
Section titled “GET /api/resource/Node”- source:
modules/node/router.go
GET /api/resource/Node/{name}
Section titled “GET /api/resource/Node/{name}”- source:
modules/node/router.go
Router method_router
Section titled “Router method_router”| Method | Path | Permission |
|---|---|---|
GET | /api/method/shc.node.deployments | platform:manage |
POST | /api/method/shc.node.health | platform:manage |
GET /api/method/shc.node.deployments
Section titled “GET /api/method/shc.node.deployments”- source:
modules/node/router.go
POST /api/method/shc.node.health
Section titled “POST /api/method/shc.node.health”- source:
modules/node/router.go
shc@docs:~$