Devices

List registered devices

client.devices.list(?): DeviceListResponse { id, bound_to_vfio, created_at, 7 more }

get/devices

Register a device for passthrough

client.devices.create(, ?): Device { id, bound_to_vfio, created_at, 7 more }

post/devices

Get device details

client.devices.retrieve(, ?): Device { id, bound_to_vfio, created_at, 7 more }

get/devices/{id}

Unregister device

client.devices.delete(, ?): void

delete/devices/{id}

Discover passthrough-capable devices on host

client.devices.listAvailable(?): DeviceListAvailableResponse { device_id, iommu_group, pci_address, 4 more }

get/devices/available

ModelsExpand Collapse

AvailableDevice { device_id, iommu_group, pci_address, 4 more }

device_id: string

PCI device ID (hex)

iommu_group: number

IOMMU group number

pci_address: string

PCI address

vendor_id: string

PCI vendor ID (hex)

current_driver?: string | null

Currently bound driver (null if none)

device_name?: string

Human-readable device name

vendor_name?: string

Human-readable vendor name

Device { id, bound_to_vfio, created_at, 7 more }

id: string

Auto-generated unique identifier (CUID2 format)

bound_to_vfio: boolean

Whether the device is currently bound to the vfio-pci driver, which is required for VM passthrough.

true: Device is bound to vfio-pci and ready for (or currently in use by) a VM. The device's native driver has been unloaded.
false: Device is using its native driver (e.g., nvidia) or no driver. Hypeman will automatically bind to vfio-pci when attaching to an instance.

created_at: string

Registration timestamp (RFC3339)

formatdate-time

device_id: string

PCI device ID (hex)

iommu_group: number

IOMMU group number

pci_address: string

PCI address

type: DeviceType

Type of PCI device

Accepts one of the following:

"gpu"

"pci"

vendor_id: string

PCI vendor ID (hex)

attached_to?: string | null

Instance ID if attached

name?: string

Device name (user-provided or auto-generated from PCI address)

DeviceType = "gpu" | "pci"

Type of PCI device

Accepts one of the following:

"gpu"

"pci"