The path needs to be created and authenticated beforehand, using the Validate path API (in the case that the path does not exist, or it's on a network share that requires auth).
This section includes the following topics:
- Input Parameters
- Output Parameters
Input Parameters
The following table provides the parameters and descriptions.
Parameter | Description |
diskLocation path | String pointing to the local or remote path where the virtual disks will be stored on a subsequent Restore API call. |
diskFormat | String. Either vhd or vhdx, depending on which format you would like a subsequent Restore operation to have. |
revisions | Array of integers. Representing the revisions that are stored by a subsequent Restore API call. |
Example
{
"diskLocation": {
"path": "c:\\destinationfolder"
},
"diskformat": "vhdx",
"revisions": [50, 52]
}
Output Parameters
None when successful, validation errors otherwise:
Not enough free space on diskLocation.path location: "Insufficient space for restore on folder PATH_HERE. Required space is: REQUIRED_SIZE_HERE bytes"
Example POST
POST /v2/accounts/test_acc/computers/0000/restore/diskimage/standard/vm/validate/freespace
Input Parameters
{
"diskLocation": {
"path": "c:\\destinationfolder"
},
"diskformat": "vhdx",
"revisions": [
50,
52
]
}
Output Parameters
Response status: 204 No content (for online operation).