ByCloud Docs
GuidesCLIAPISDK
patch/v1/volumes/{volume_id}

Update volume

Update a volume's name, description, or metadata

Path Parameters

volume_id

string<uuid>required

path

Volume ID

Example: "550e8400-e29b-41d4-a716-446655440000"

Request Body

required

Content-Type: application/json

name

stringoptional

description

stringoptional

metadata

objectoptional

Responses

200

Volume updated

Content-Type: application/json

volume

objectoptional
400

Invalid request parameters

Content-Type: application/json

error

objectrequired
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
404

Resource not found

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X PATCH "https://api.spo1.mycloud.com/v1/volumes/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "metadata": {
      "environment": "production",
      "team": "backend"
    }
  }'

Response

Volume updated

{
  "volume": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "crn": "crn:spo1:storage:volume:550e8400-e29b-41d4-a716-446655440000",
    "name": "data-volume-01",
    "description": "Primary data volume",
    "status": "available",
    "size": 100,
    "volume_type": "ssd",
    "bootable": false,
    "encrypted": false,
    "multiattach": false,
    "source_volume_id": "550e8400-e29b-41d4-a716-446655440000",
    "snapshot_id": "550e8400-e29b-41d4-a716-446655440000",
    "image_id": "550e8400-e29b-41d4-a716-446655440000",
    "attachments": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "instance_id": "550e8400-e29b-41d4-a716-446655440001",
        "device": "/dev/vdb",
        "attached_at": "2024-01-15T10:30:00Z"
      }
    ],
    "metadata": {
      "environment": "production",
      "team": "backend"
    },
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}