List volumes

client.volumes.list(?): VolumeListResponse { id, created_at, name, 2 more }

get/volumes

List volumes

ReturnsExpand Collapse

VolumeListResponse = Array<Volume { id, created_at, name, 2 more } >

id: string

Unique identifier

created_at: string

Creation timestamp (RFC3339)

formatdate-time

name: string

Volume name

size_gb: number

Size in gigabytes

attachments?: Array<VolumeAttachment { instance_id, mount_path, readonly } >

List of current attachments (empty if not attached)

instance_id: string

ID of the instance this volume is attached to

mount_path: string

Mount path in the guest

readonly: boolean

Whether the attachment is read-only

List volumes

import Hypeman from '@onkernel/hypeman';

const client = new Hypeman({
  apiKey: 'My API Key',
});

const volumes = await client.volumes.list();

console.log(volumes);

[
  {
    "id": "vol-data-1",
    "created_at": "2025-01-15T09:00:00Z",
    "name": "my-data-volume",
    "size_gb": 10,
    "attachments": [
      {
        "instance_id": "inst-abc123",
        "mount_path": "/mnt/data",
        "readonly": false
      }
    ]
  }
]

Returns Examples

[
  {
    "id": "vol-data-1",
    "created_at": "2025-01-15T09:00:00Z",
    "name": "my-data-volume",
    "size_gb": 10,
    "attachments": [
      {
        "instance_id": "inst-abc123",
        "mount_path": "/mnt/data",
        "readonly": false
      }
    ]
  }
]