Skip to main content

VM File Recover​

Select

SaaS
Customer Managed

Recover the VM Files provided

Path Parameters
  • vmClientGUID string required
Request Body
  • inPlaceRestore boolean required

    The option to restore backed-up data to the same client from which it was backed up.

  • passUnconditionalOverride boolean

    The option to overwrite an existing virtual machine of the same name.

  • destinationClient object

    Required for out of place recover

  • clientName string

    Destination client name of hypervisor

  • vmFileLevelRestoreOptions object required
  • destPath string[]

    Destination paths to which files has to be recovered

  • sourcePath string[]

    List of Source paths to recover

  • destinationVMGuid string

    The GUID of the VM to which the files would be restored

  • guestCredentials object

    Required if you are restoring to another VM instead of client . Pass the VM credentials to connect to the VM where files has to be restored

  • userName string

    Guest credential username

  • password string

    Base 64 encoded password

Responses

OK

Schema
  • taskId integer
  • jobIds string[]
POST /v2/vsa/vm/:vmclientguid/recoverfile

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
vmClientGUID — path required
Body
{

  "inPlaceRestore": true,

  "passUnconditionalOverride": true,

  "destinationClient": {

    "clientName": "string"

  },

  "vmFileLevelRestoreOptions": {

    "destPath": [

      "string"

    ],

    "sourcePath": [

      "C:\test\test1.txt (windows) /vol2/var/test1.txt( for unix where vol2 is mountpoint name )"

    ],

    "destinationVMGuid": "string",

    "guestCredentials": {

      "userName": "string",

      "password": "string"

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/v2/vsa/vm/:vmClientGUID/recoverfile' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "inPlaceRestore": true,
  "passUnconditionalOverride": true,
  "destinationClient": {
    "clientName": "string"
  },
  "vmFileLevelRestoreOptions": {
    "destPath": [
      "string"
    ],
    "sourcePath": [
      "C:\test\test1.txt (windows) /vol2/var/test1.txt( for unix where vol2 is mountpoint name )"
    ],
    "destinationVMGuid": "string",
    "guestCredentials": {
      "userName": "string",
      "password": "string"
    }
  }
}'