The API allows you to list, view, edit and create virtual machine disks.
Returns list of virtual machine disks filtered by specified query parameters.
name | type | description | constraints |
---|---|---|---|
hypervisor | query | ||
hypervisor-cluster | query | ||
hypervisor-manager | query | ||
type | query | "AZURE_DATA_DISK_LINUX" or "AZURE_DATA_DISK_WINDOWS" or "AZURE_OS_DISK_LINUX" or "AZURE_OS_DISK_WINDOWS" or "GCP_EPHEMERAL" or "GCP_PERSISTENT" or "OPENNEBULA_PERSISTENT" or "OPENNEBULA_VOLATILE" or "OPENSHIFT_CDROM" or "OPENSHIFT_DISK" or "OPENSHIFT_LUN" or "OPENSHIFT_UNSNAPSHOTTABLE_DISK" or "OPENSTACK_CINDER" or "OPENSTACK_EPHEMERAL" or "OPENSTACK_GLANCE" or "OPENSTACK_NOVA" or "OPENSTACK_SWAP" or "UNKNOWN" | |
uuid | query | ||
virtual-machine | query |
media type | data type | description |
---|---|---|
application/json | array of VmDiskDetails (JSON) | list of virtual machine disks filtered by specified query parameters |
GET /virtual-machine-disks
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"name" : "...",
"uuid" : "...",
"devicePath" : "...",
"fullDevicePath" : "...",
"controllerId" : "...",
"slot" : "...",
"virtualMachine" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"originalStorage" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"size" : 12345,
"present" : true,
"excludedFromBackup" : true,
"bootable" : true,
"image" : true,
"volumeSource" : "...",
"volumeType" : "...",
"snapshots" : [ {
"vmDisk" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupRule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"cbtId" : "..."
}, {
"vmDisk" : {
"guid" : "...",
"name" : "..."
},
"backupRule" : {
"guid" : "...",
"name" : "..."
},
"cbtId" : "..."
} ],
"type" : "AZURE_OS_DISK_LINUX",
"supported" : true
} ]
Get a single virtual machine disk details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for virtual machine disk (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | VmDiskDetails (JSON) | a single virtual machine disk details |
GET /virtual-machine-disks/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"guid" : "...",
"name" : "...",
"uuid" : "...",
"devicePath" : "...",
"fullDevicePath" : "...",
"controllerId" : "...",
"slot" : "...",
"virtualMachine" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"originalStorage" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"size" : 12345,
"present" : true,
"excludedFromBackup" : true,
"bootable" : true,
"image" : true,
"volumeSource" : "...",
"volumeType" : "...",
"snapshots" : [ {
"vmDisk" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupRule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"cbtId" : "..."
}, {
"vmDisk" : {
"guid" : "...",
"name" : "..."
},
"backupRule" : {
"guid" : "...",
"name" : "..."
},
"cbtId" : "..."
} ],
"type" : "OPENSHIFT_UNSNAPSHOTTABLE_DISK",
"supported" : true
}
Change virtual machine disk settings.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for virtual machine disk (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | VmDiskSettingsUpdate (JSON) | specify virtual machine disk settings to update |
media type | data type | description |
---|---|---|
application/json | VmDiskDetails (JSON) | updated details of virtual machine disk |
PUT /virtual-machine-disks/{guid}/settings
Content-Type: application/json
Accept: application/json
{
"excludedFromBackup" : true
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guid" : "...",
"name" : "...",
"uuid" : "...",
"devicePath" : "...",
"fullDevicePath" : "...",
"controllerId" : "...",
"slot" : "...",
"virtualMachine" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"originalStorage" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"size" : 12345,
"present" : true,
"excludedFromBackup" : true,
"bootable" : true,
"image" : true,
"volumeSource" : "...",
"volumeType" : "...",
"snapshots" : [ {
"vmDisk" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupRule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"cbtId" : "..."
}, {
"vmDisk" : {
"guid" : "...",
"name" : "..."
},
"backupRule" : {
"guid" : "...",
"name" : "..."
},
"cbtId" : "..."
} ],
"type" : "OPENSTACK_SWAP",
"supported" : true
}