Restore files and folders of a virtual machine.

post/backup-recovery/v1beta1/virtual-machines/{id}/restore-files

Restore one or more files and folders of a virtual machine from snapshot or backup.

Securitybearer
Request
path Parameters
id
required
string

UUID string uniquely identifying the virtual machine

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Request Body schema: application/json
required
One of:

Definition for the request body for restoring virtual machine files and folders from a snapshot.

required
Array of objects

Specifies absolute path of selected files or folders and target destination.

fileRestoreMethod
required
string

Specifies the action if the destination already contains a file or folder with the same name.
OVERWRITE - Existing files/folders will be replaced with the restored files/folders from the copy.
KEEPASBACKUP - The restored files/folders will be maintained as a copy on the destination with timestamp appended to their names.
SKIP - The files/folders will be skipped during restore.

Enum: "OVERWRITE" "KEEPASBACKUP" "SKIP"
retainOriginalDirectoryStructure
boolean

Specifies if restore preserves the source directory structure at the destination when restoring a file or folder.

snapshotId
required
string

UUID string uniquely identifying the snapshot. Mandatory if the restore is from a snapshot.

required
object

Target system information onto which the files and folders are restored to.

Responses
202

Accepted

400

Bad request

401

Unauthorized

403

Forbidden

409

Conflict

412

Precondition failed (if the generation number is invalid).

500

Internal / unexpected error.

Request samples
application/json
{
  • "filePathInfo": [
    ],
  • "fileRestoreMethod": "OVERWRITE",
  • "retainOriginalDirectoryStructure": true,
  • "snapshotId": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  • "targetInfo": {
    }
}
Response samples
application/json
{ }