Skip to content
SHC Docs

Vault API

  • router → prefix /api/resource/Secret (tags: Secret)
  • method_router → prefix /api/method (tags: Vault Methods)

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

MethodPathPermission
GET/api/resource/Secrettenant:read
POST/api/resource/Secrettenant:manage
DELETE/api/resource/Secret/{key:path}tenant:manage
GET/api/resource/Secret/{key:path}tenant:manage
PUT/api/resource/Secret/{key:path}tenant:manage
MethodPathPermission
GET/api/method/shc.vault.existstenant:read
GET/api/method/shc.vault.statusopen
POST/api/method/shc.vault.unlockopen
POST/api/method/shc.vault.rotateopen
POST/api/method/shc.vault.exporttenant:manage
POST/api/method/shc.vault.importtenant:manage

Peer functions served through POST /internal/rpc/{function} on the internal listener (not the public API), source modules/vault/rpc.go:

FunctionPurpose
vault.unlockAn unlocked peer pushes the master password to this node
vault.rekeyValidated live re-key on rotate
vault.request_unlockA locked node asks an unlocked peer to push the unlock back
vault.coldstart_plantWrite this node’s auto-unlock drop-in pair
vault.coldstart_uprootRemove it