ByCloud Docs
GuidesCLIAPISDK
post/v1/volumes

Create volume

Create a new block storage volume

Request Body

required

Content-Type: application/json

name

stringoptional

description

stringoptional

size

integerrequired

Size in GB

volume_type

stringoptional

Volume type name or ID

snapshot_id

string<uuid>optional

Create volume from snapshot

source_volume_id

string<uuid>optional

Clone from existing volume

image_id

string<uuid>optional

Create volume from image

multiattach

booleanoptional

Default: false

metadata

objectoptional

Responses

202

Volume creation initiated

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
403

Insufficient permissions

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X POST "https://api.spo1.mycloud.com/v1/volumes" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "data-volume-01",
    "description": "string",
    "size": 100,
    "volume_type": "ssd",
    "snapshot_id": "550e8400-e29b-41d4-a716-446655440000",
    "source_volume_id": "550e8400-e29b-41d4-a716-446655440000",
    "image_id": "550e8400-e29b-41d4-a716-446655440000",
    "multiattach": false,
    "metadata": {
      "environment": "production",
      "team": "backend"
    }
  }'

Response

Volume creation initiated

{
  "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"
  }
}