Update Volume

PUT/v3/{project_id}/volumes/{volume_id}

Updates the editable attributes of a volume: name, description, and metadata. Size and type are not changed here; use the extend or retype volume action instead.

info

Source: update-a-volume

Request

Parameters

project_idstringrequiredpath

The UUID of the project.

volume_idstringrequiredpath

The UUID of the volume.

volumeobjectrequiredbody

Volume wrapper.

3 fields

namestringbody

New volume name.

descriptionstringbody

New volume description.

metadataobjectbody

Metadata key/value pairs to associate with the volume.

Sample Request

curl -ks -X PUT -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
-d '{
  "volume": {
    "name": "vol3"
  }
}' https://api.vietnix.cloud:8776/v3/{project_id}/volumes/{volume_id}

Response

Sample Response

Response body

{
  "volume": {
    "id": "de5b7dfc-e3e8-4f14-9969-98d61af40329",
    "name": "vol3",
    "description": "Volume 2",
    "status": "available",
    "size": 3,
    "volume_type": "default",
    "attachments": [],
    "multiattach": false,
    "metadata": {},
    "created_at": "2026-02-18T09:12:44.000000",
    "updated_at": "2026-02-18T09:41:02.000000"
  }
}

Status Code

Success

Status Code	Description
200 - OK	The volume was updated.

Error

Status Code	Description
400 - Bad Request	Some content in the request was invalid.
401 - Unauthorized	User must authenticate before making a request.
403 - Forbidden	Policy does not allow current user to do this operation.
404 - Not Found	The volume does not exist, or is not visible to your project.

note

Renaming a volume does not change the device path inside a guest that already has it attached. Metadata is replaced for the keys you send, not merged with the existing map.