Devices
List registered devices
get/devices
Register a device for passthrough
post/devices
Get device details
get/devices/{id}
Unregister device
delete/devices/{id}
Discover passthrough-capable devices on host
get/devices/available
ModelsExpand Collapse
AvailableDevice = object { device_id, iommu_group, pci_address, 4 more }
AvailableDevice = object { 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: optional string
Currently bound driver (null if none)
device_name: optional string
Human-readable device name
vendor_name: optional string
Human-readable vendor name
Device = object { id, bound_to_vfio, created_at, 8 more }
Device = object { id, bound_to_vfio, created_at, 8 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 of PCI device
Type of PCI device
Accepts one of the following:
"gpu"
"pci"
vendor_id: string
PCI vendor ID (hex)
attached_to: optional string
Instance ID if attached
name: optional string
Device name (user-provided or auto-generated from PCI address)
tags: optional map[string]
User-defined key-value tags.
DeviceType = "gpu" or "pci"Type of PCI device
DeviceType = "gpu" or "pci"
Type of PCI device
Accepts one of the following:
"gpu"
"pci"