IRPCVaultsAdmin.DetachVault
Administration API / specialized admin session
Removes the vault from the server's list of registered vaults but does not remove the metadata database or file data files.
| Service | Vault management MFiles.IRPCVaultsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCVaultsAdmin/DetachVault |
| HTTP (mf-http-grpc) | POST /grpc/v1/detach-vault |
| Request | DetachVaultRequest |
| Response | DetachVaultResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires the system administrator server role (server right
manage_vaults). - Takes the vault offline first: open sessions to the vault are disconnected. The metadata database and the file data stay, and AttachExistingVault can attach them again, on this or another server.
Request: DetachVaultRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
vault | string | The GUID of the vault to detach. |
Response: DetachVaultResponse
No fields.
Related methods
- AttachExistingVault -- Attaches an existing vault (metadata database and file data files) to the server.