Skip to content
SHC Docs

Storage API

Routers

Section titled “Routers”
  • method_router → prefix /api/method

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

MethodPathPermission
POST/api/method/shc.storage.addplatform:manage
POST/api/method/shc.storage.rmplatform:manage
POST/api/method/shc.storage.get—
POST / GET/api/method/shc.storage.ls—
POST/api/method/shc.storage.linkplatform:manage
POST/api/method/shc.storage.unlinkplatform:manage
GET/api/method/shc.storage.logs.stream—
POST/api/method/shc.storage.cephfs.enableplatform:manage
POST/api/method/shc.storage.cephfs.disableplatform:manage
POST/api/method/shc.storage.cephfs.joinplatform:manage
POST/api/method/shc.storage.cephfs.leaveplatform:manage
POST/api/method/shc.storage.cephfs.status—
POST/api/method/shc.storage.cephfs.health—
POST/api/method/shc.storage.nfs.enableplatform:manage
POST/api/method/shc.storage.nfs.disableplatform:manage
POST/api/method/shc.storage.nfs.joinplatform:manage
POST/api/method/shc.storage.nfs.leaveplatform:manage
POST/api/method/shc.storage.nfs.status—
POST/api/method/shc.storage.volume.ls—
POST/api/method/shc.storage.volume.rebindplatform:manage
POST/api/method/shc.storage.volume.rmplatform:manage

Internal (peer) routes

Section titled “Internal (peer) routes”

Node-to-node storage provisioning, on the internal listener:

MethodPath
GET/internal/storage/nfs/status
POST/internal/storage/nfs/enable-server
POST/internal/storage/nfs/enable-client
POST/internal/storage/nfs/disable
POST/internal/storage/cephfs/enable-client
POST/internal/storage/cephfs/disable
POST/internal/storage/volume/mount
POST/internal/storage/volume/unmount

POST /api/method/shc.storage.add

Section titled “POST /api/method/shc.storage.add”

POST /api/method/shc.storage.cephfs.disable

Section titled “POST /api/method/shc.storage.cephfs.disable”

POST /api/method/shc.storage.cephfs.enable

Section titled “POST /api/method/shc.storage.cephfs.enable”

POST /api/method/shc.storage.cephfs.join

Section titled “POST /api/method/shc.storage.cephfs.join”

POST /api/method/shc.storage.cephfs.leave

Section titled “POST /api/method/shc.storage.cephfs.leave”

POST /api/method/shc.storage.cephfs.status

Section titled “POST /api/method/shc.storage.cephfs.status”

POST /api/method/shc.storage.rm

Section titled “POST /api/method/shc.storage.rm”

POST /api/method/shc.storage.get

Section titled “POST /api/method/shc.storage.get”

POST /api/method/shc.storage.link

Section titled “POST /api/method/shc.storage.link”

POST /api/method/shc.storage.ls

Section titled “POST /api/method/shc.storage.ls”

POST /api/method/shc.storage.nfs.disable

Section titled “POST /api/method/shc.storage.nfs.disable”

POST /api/method/shc.storage.nfs.enable

Section titled “POST /api/method/shc.storage.nfs.enable”

POST /api/method/shc.storage.nfs.join

Section titled “POST /api/method/shc.storage.nfs.join”

POST /api/method/shc.storage.nfs.leave

Section titled “POST /api/method/shc.storage.nfs.leave”

POST /api/method/shc.storage.nfs.status

Section titled “POST /api/method/shc.storage.nfs.status”

POST /api/method/shc.storage.unlink

Section titled “POST /api/method/shc.storage.unlink”