IRPCServerAdmin.BackUp

Administration API / specialized admin session

Starts a backup of a vault or of the master database as a server job and returns the job ID.

Service	Server administration `MFiles.IRPCServerAdmin`
gRPC method	`/MFiles.IRPCServerAdmin/BackUp`
HTTP (mf-http-grpc)	`POST /grpc/v1/back-up`
Request	`BackUpRequest`
Response	`BackUpResponse`
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

Starts a background job and returns before it completes. The ID is a scheduled job ID: follow it with GetScheduledJob, cancel it with CancelScheduledJob, and remove the job with RemoveScheduledJob when it has finished (M-Files Admin does this).
Requires the system administrator server role: server right backup_vaults for a vault, backup_master_database when backupjob.vault_guid is the null GUID.
For a vault, the call first waits for the vault to finish any ongoing online/offline change.

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
`backupjob`	`BackupJob`	What to back up and where. Set `vault_guid` to the vault, or to `{00000000-0000-0000-0000-000000000000}` for the master database. See BackupJob.
`backupjob.vault_guid`	`string`	The GUID of the vault, or GUID_NULL if defining a backup of the master database.
`backupjob.type`	`BackupType`	Backup type (e.g. full or differential).Values: `BACKUP_TYPE_FULL` (0), `BACKUP_TYPE_DIFFERENTIAL` (1).
`backupjob.target_file`	`string`	Full path to the target file on server.
`backupjob.impersonation`	`Impersonation`	Impersonation information for accessing the backup target file on server.
`backupjob.impersonation.type`	`ImpersonationType`	Impersonation type.Values: `IMPERSONATION_TYPE_SYSTEM_ACCOUNT` (0), `IMPERSONATION_TYPE_LOCAL_WINDOWS_ACCOUNT` (1), `IMPERSONATION_TYPE_EXTERNAL_ACCOUNT` (2).
`backupjob.impersonation.account`	`string`	Account name (e.g. DOMAIN\user).
`backupjob.impersonation.encrypted_password`	`bytes`	Encrypted password.
`backupjob.overwrite_existing_files`	`bool`	If true, existing target files are overwritten. If false, backup fails if a target file already exists.
`backupjob.file_size_limit_in_mb`	`uint32`	Maximum size of one backup file in megabytes. If exceeded, backup will continue in a new sequentially numbered file. If zero, file size is unlimited and the backup will always consist of a single file only.

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
`task_id`	`int32`	The ID of the scheduled job that runs the backup.

IRPCScheduledJobsAdmin.GetScheduledJob -- Gets one scheduled job and its run state.
IRPCScheduledJobsAdmin.CancelScheduledJob -- Asks a running scheduled job to stop.
IRPCScheduledJobsAdmin.RemoveScheduledJob -- Removes a scheduled job.
BackUpMasterDB -- Backs up the server's master database to a file on the server, and returns when the backup is complete.