Delete Block Device

Delete Block Device

Delete a BlockDevice

  1. A block device cannot be deleted when attached to a machine.

  2. A block device with persistent property set to 'false' is deleted.

  3. A block device with persistent property set to 'true' needs an additional parameter 'purge' to be set to true, for deletion.

Request
URI
DELETE
https://vra-interop-222-139.lvn.broadcom.net/iaas/api/block-devices/{id}
COPY
Path Parameters
string
id
Required

The ID of the block device.

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

boolean
purge
Optional

Controls whether this is a force delete operation. If true, best effort is made for deleting this block device. Use with caution as force deleting may cause inconsistencies between the cloud provider and VMware Aria Automation.

boolean
forceDelete
Optional

Controls whether this is a force delete operation. If true, best effort is made for deleting this block device. Use with caution as force deleting may cause inconsistencies between the cloud provider and VMware Aria Automation.

Authentication
This operation uses the following authentication methods.
Responses
202

Accepted

Returns RequestTracker of type(s) application/json 
{
    "progress": 90,
    "message": "In Progress",
    "status": "FINISHED",
    "resources": [
        "/resources/i-0be3655a12fd28e8e",
        "/resources/i-0be234a15ft8det3"
    ],
    "name": "Power-off",
    "id": "we655aew4e8e",
    "selfLink": "/.../request-tracker/we655aew4e8e",
    "deploymentId": "123e4567-e89b-12d3-a456-426614174000"
}
integer As int32 As int32
progress
Required

Progress of the request as percentage.

string
message
Optional

Status message of the request.

string
status
Required

Status of the request.

Possible values are : FINISHED, INPROGRESS, FAILED,
array of string
resources
Optional

Collection of resources.

string
name
Optional

Name of the operation.

string
id
Required

ID of this request.

string
selfLink
Required

Self link of this request.

string
deploymentId
Optional

ID of the deployment, this request is connected to.


204

No Content

Operation doesn't return any data structure

403

Forbidden

Returns ServiceErrorResponse of type(s) application/json 
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


Code Samples
COPY
                    curl -X DELETE -H 'Authorization: <value>' https://{api_host}/iaas/api/block-devices/{id}
On This Page
Disk Operations
POST
Create Block Device Snapshot
POST
Promote Disk
GET
Get Block Device
POST
Resize Block Device
DELETE
Delete Block Device
POST
Revert Disk Snapshot
GET
Get Block Devices
POST
Create Block Device
GET
Get Disk Snapshot
DELETE
Delete Block Device Snapshot
GET
Get Disk Snapshots