IRPCVaultsAdmin.GetBackupFileContents

Administration API / specialized admin session idempotent

Reads the vault identity and data folders stored in a backup file on the server.

Service	Vault management `MFiles.IRPCVaultsAdmin`
gRPC method	`/MFiles.IRPCVaultsAdmin/GetBackupFileContents`
HTTP (mf-http-grpc)	`POST /grpc/v1/get-backup-file-contents`
Request	`GetBackupFileContentsRequest`
Response	`GetBackupFileContentsResponse`
Book and level	Administration API, specialized
Kind	admin
Session	Required: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotent	yes
Returns metadata structure version	no
Streaming	none (unary)

Remarks

Requires the system administrator server role (server right restore_vault).
Read-only. Use it before RestoreVault to show which vault a backup holds and where its data was.

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
`backup_file_full`	`string`	The full backup file, as a path on the server machine.
`backup_file_differential`	`string`	An optional differential backup file to apply on top of the full backup, as a path on the server machine. Leave empty if none.
`utf8szimpersonation`	`Impersonation`	The account the server uses to read the backup files. Unset means `IMPERSONATION_TYPE_SYSTEM_ACCOUNT`.
`utf8szimpersonation.type`	`ImpersonationType`	Impersonation type.Values: `IMPERSONATION_TYPE_SYSTEM_ACCOUNT` (0), `IMPERSONATION_TYPE_LOCAL_WINDOWS_ACCOUNT` (1), `IMPERSONATION_TYPE_EXTERNAL_ACCOUNT` (2).
`utf8szimpersonation.account`	`string`	Account name (e.g. DOMAIN\user).
`utf8szimpersonation.encrypted_password`	`bytes`	Encrypted password.

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
`master_db`	`bool`	True if the file is a backup of the master database, not of a vault.
`display_name`	`string`	Receives the display name of the vault.
`vault`	`string`	Receives the unique ID of the vault.
`data_folder`	`string`	Receives the data folder of the vault.
`file_data_folders[]`	repeated `AdditionalFolder`	Receives the additional file data folders.
`file_data_folders[].path`	`string`	Path (e.g. "\servername\sharename\folder").
`file_data_folders[].limit_in_mb`	`uint32`	Data limit in megabytes or zero if no limit.
`file_data_folders[].impersonation`	`Impersonation`	Impersonation information for accessing the folder.
`file_data_folders[].impersonation.type`	`ImpersonationType`	Impersonation type.Values: `IMPERSONATION_TYPE_SYSTEM_ACCOUNT` (0), `IMPERSONATION_TYPE_LOCAL_WINDOWS_ACCOUNT` (1), `IMPERSONATION_TYPE_EXTERNAL_ACCOUNT` (2).
`file_data_folders[].impersonation.account`	`string`	Account name (e.g. DOMAIN\user).
`file_data_folders[].impersonation.encrypted_password`	`bytes`	Encrypted password.

RestoreVault -- Restores a vault from backup files on the server and attaches it.