This API can be used for discovering information needed to create Disk Image backup sets.
Input Parameters
None.
Output Parameters
The following table provides the input parameters and descriptions.
Parameter | Description |
deviceId | String. Use this value for creating a Disk Image Backup Set (preferred over using the drive letter, since not all volumes have drive letters). |
driveLetter | String. Use this value for creating a Disk Image Backup Set, but this is not preferred. Deviceid is recommended. |
label | String. Volume label (can be empty). |
capacity | Long. Volume capacity in bytes. |
usedSpace | Long. Volume used space in bytes. |
isBoot | Boolean, whether the volume is boot or not. |
volumeKind | Integer. Contains the following possible integer values (parenthesis lists enum's value):
|
driveType | Integer, with the following possible values (matches System.IO.DriveType). Only Fixed drives are supported:
|
isSupported | Boolean. Determines whether the volume is supported for backup or not. When false, the reason can be found via the volumeUnsupportedReason property |
volumeUnsupportedReason | Integer. When > 0, shows the reason why a volume is unsupported, with the following possible values:
|
Example GET
Input Parameters
Headers:
- Authorization: Oauth TOKEN
- Accept: application/json
- Content-Type: application/json
Required scope: computers_read+computers_write
Method: GET
Request parameters
The following table provides the input parameters and descriptions.
Parameter | Description |
account | String ( mandatory ). The parameter represents the account name. |
computer | String ( mandatory ). The parameter represents the subaccount of the current account. |
Output data
Basic Request Example:
curl --request GET \
url https://v2/accounts/{username}/computers/{computer}/backupsets/diskimage/volumes/browse
header 'authorization: Oauth f6aea1ecce5651f2166e6b828516ed44'
Sample result
The result must have the same structure as the example displayed above.