This API has a deprecated equivalent from v7.0U1.
Delete Hardware Disk
DescriptionRemoves a virtual disk from the virtual machine. This operation does not destroy the VMDK file that backs the virtual disk. It only detaches the VMDK file from the virtual machine. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/hardware/disk/{disk}
Path Parameters
Path Parameters
string
vm
Required
Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
string
disk
Required
Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine is suspended or if the virtual machine is powered on and virtual disk type is IDE.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
404
com.vmware.vapi.std.errors.not_found : if the virtual machine or virtual disk is not found.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine’s configuration state cannot be accessed.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-DeleteVmDiskHardware -Vm "MyVm" -Disk "MyDisk"
cURL Command
curl -X DELETE -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/hardware/disk/{disk}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: delete
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/hardware/disk/{disk}
x-vmw-doc-operation: delete
Availability
Added in 7.0U2
On This Page
Hardware Disk Operations
post
patch
delete
