IRPCVaultsAdmin.DestroyVault
Administration API / specialized admin session
Destroys a vault: deletes its metadata database and its file data permanently and removes it from the server.
| Service | Vault management MFiles.IRPCVaultsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCVaultsAdmin/DestroyVault |
| HTTP (mf-http-grpc) | POST /grpc/v1/destroy-vault |
| Request | DestroyVaultRequest |
| Response | DestroyVaultResponse |
| 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
- Destroys the vault and its data permanently. Use DetachVault to remove the vault from the server and keep the data.
- Requires the system administrator server role (server right
manage_vaults). - The vault is taken offline first: open sessions to the vault are disconnected.
- With
forcefalse, the call fails if the server cannot connect to the vault's SQL Server; withforcetrue the vault is destroyed anyway and its database may be left on that SQL Server.
Request: DestroyVaultRequest
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 destroy, in braces, e.g. {7BBEA0BC-40D8-4BCB-A67D-8A3ACFBDB575}. |
force | bool | True to destroy the vault even if the server cannot connect to the vault's database server; the database may then be left on that server. False to fail in that case. |
Response: DestroyVaultResponse
No fields.
Related methods
- DetachVault -- Removes the vault from the server's list of registered vaults but does not remove the metadata database or file data files.