ByCloud Docs
GuidesCLIAPISDK
get/v1/volumes

List volumes

List all volumes in the current organization

Query Parameters

limit

integeroptional

query

Maximum number of items to return

Default: 20

Example: 20

marker

string<uuid>optional

query

ID of the last item from the previous page (for pagination)

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

name

stringoptional

query

Filter by name (exact match or prefix with *)

Example: "web-*"

status

stringoptional

query

Filter by status

Example: "ACTIVE"

bootable

booleanoptional

query

Filter by bootable status

Responses

200

List of volumes

Content-Type: application/json

volumes

arrayoptional

meta

objectoptional

links

objectoptional
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X GET "https://api.spo1.mycloud.com/v1/volumes" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

Response

List of volumes

{
  "volumes": [
    {
      "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"
    }
  ],
  "meta": {
    "total": 150,
    "limit": 20,
    "marker": "550e8400-e29b-41d4-a716-446655440000",
    "has_more": true
  },
  "links": {
    "self": "https://api.spo1.mycloud.com/v1/instances?limit=20",
    "next": "https://api.spo1.mycloud.com/v1/instances?limit=20&marker=550e8400-e29b-41d4-a716-446655440000",
    "previous": "https://api.spo1.mycloud.com/v1/instances?limit=20&marker=440e8400-e29b-41d4-a716-446655440000"
  }
}