Bulk volume delete API

Edit online

The bulk volume delete API lets you delete bulk volumes.

Bulk volume delete option

Table 1. Option for bulk volume delete API
Method URI Description
POST /v3/{project_id}/bulk-volumes/action Deletes bulk volumes.
Example of request body.
{
   "bulk-volume-delete": {
       "volumes": ["volume-id1", "volume-id2"],
       "force": <optional> True,
       "cascade": <optional> True
   }
}
Response code
  • Normal: Accepted (202)
  • Failure: Partial Content (206), Bad Request (400), Unauthorized (401), Forbidden (403), Not Found (404), Internal Server Error (500)

Request parameters

Table 2. Parameters in the request for performing bulk volume delete
Name Style Type Description
volumes body list of strings Array of volumes for deletion.
force (optional) body boolean Attempts forced removal of volume(s) regardless of the state. The default value is False.
cascade (optional) body boolean Removes any snapshots along with the volume. The default value is False.