Skip to main content

VM Recover​

Select

SaaS
Customer Managed

This operation initiates a restore operation for a virtual machine and returns the details for the restore job. You can perform an in-place restore or an out-of-place restore of a virtual machine. Supported vendors: VMware, vCloud and HyperV

Note:

vmClientGUIDis the client GUID of the backed-up VM. You can use "Get all VMs" API to fetch the client GUID from the client properties of the VM.
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. Set to false for out of place recover

  • passUnconditionalOverride boolean

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

  • powerOnVmAfterRestore boolean

    The option to start the virtual machine after it is restored.

  • destinationClient object

    Required for out of place recover

  • clientName string

    Destination client name of the hypervisor

  • destinationInfo object[]

    Required for out of place recover

  • vmware object
  • esxHost string

    EsxHost in the Vcenter to which this VM has to be restored

  • newName string

    New restore name for the VM

  • dataStore string

    Datastore in the Vcenter to which this VM has to be restored

  • resourcePool string

    ResourcedPool in the Vcenter to which this VM has to be restored

  • vcloud object
  • newName string

    New name of the VM

  • esxHost string

    Destination esx host of the VM

  • dataStore string

    Destination Storage Policy GUID of the VM

  • vCloudOrgName string

    Name of the destination vCloud Organisation

  • vCDName string

    Name of the destination vCloud Org VDC

  • vAppName string

    Name of the destination vApp

  • vCloudOwner string

    Name of the owner of the VM

  • hyperv object
  • newName string
  • destinationPath string
  • registerwithFailover string
Responses

OK

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

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,

  "powerOnVmAfterRestore": true,

  "destinationClient": {

    "clientName": "string"

  },

  "destinationInfo": [

    {

      "vmware": {

        "esxHost": "string",

        "newName": "string",

        "dataStore": "string",

        "resourcePool": "string"

      },

      "vcloud": {

        "newName": "string",

        "esxHost": "string",

        "dataStore": "string",

        "vCloudOrgName": "string",

        "vCDName": "string",

        "vAppName": "string",

        "vCloudOwner": "string"

      },

      "hyperv": {

        "newName": "string",

        "destinationPath": "string",

        "registerwithFailover": "string"

      }

    }

  ]

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/v2/vsa/vm/:vmClientGUID/recover' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "inPlaceRestore": true,
  "passUnconditionalOverride": true,
  "powerOnVmAfterRestore": true,
  "destinationClient": {
    "clientName": "string"
  },
  "destinationInfo": [
    {
      "vmware": {
        "esxHost": "string",
        "newName": "string",
        "dataStore": "string",
        "resourcePool": "string"
      },
      "vcloud": {
        "newName": "string",
        "esxHost": "string",
        "dataStore": "string",
        "vCloudOrgName": "string",
        "vCDName": "string",
        "vAppName": "string",
        "vCloudOwner": "string"
      },
      "hyperv": {
        "newName": "string",
        "destinationPath": "string",
        "registerwithFailover": "string"
      }
    }
  ]
}'