List Volumes

GET /v1/volumes/list

Example response

Response (200)

{
  "data": [
    {
      "id": "vol_x1y2z3a4b5c6d7e8",
      "name": "my-volume",
      "type": "volume",
      "created_at": "2024-01-15T12:00:00Z",
      "size": "10Gi",
      "status": "Bound",
      "in_use": true,
      "mounted_by": {
        "sandbox_id": "sbx_y2z3a4b5c6d7e8f9",
        "sandbox_name": "user-123-my-sandbox"
      }
    },
    {
      "id": "snap_y2z3a4b5c6d7e8f9",
      "name": "my-snapshot-2024-01-15",
      "type": "snapshot",
      "created_at": "2024-01-15T14:00:00Z",
      "size": "10Gi",
      "status": "Ready",
      "in_use": false,
      "source_volume_id": "vol_x1y2z3a4b5c6d7e8",
      "source_volume_name": "my-volume"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 20,
    "total_pages": 1,
    "total_items": 2
  }
}

---

Authorizations

• x-api-key (header, required) API key provided in the x-api-key header. Required.

---

Query parameters

• page (number) — default: 1 Page number. Required range: x > 1

• page_size (number) — default: 20 Page size. Required range: 1 < x < 100

---

Response (200) — Schema

data (array) — required Array of volumes and snapshots.

data[] attributes

• id (string) — required Volume or Snapshot ID

• name (string) — required Volume or Snapshot name

• created_at (string) — required Creation timestamp

• size (string) — required Volume size (for volumes) or source volume size (for snapshots)

• status (string) — required Volume status (Pending/Bound/Lost) or Snapshot status (Ready/Pending)

• type (enum) — required Type: volume for persistent volumes, snapshot for point-in-time snapshots

• in_use (boolean) — required Whether the volume is currently mounted by a sandbox (always false for snapshots)

• mounted_by (object) — optional, only for volumes in use Sandbox information if volume is in use

  • mounted_by.sandbox_id (string) — required

  • mounted_by.sandbox_name (string) — required

• source_volume_id (string) — optional Source volume ID for snapshots

• source_volume_name (string) — optional Source volume name for snapshots

pagination attributes

• pagination.page (number) — required Current page number

• pagination.page_size (number) — required Number of items per page

• pagination.total_pages (number) — required Total number of pages

• pagination.total_items (number) — required Total number of items