Skip to navigation

Retrieve a device

View as MarkdownOpen in Claude

Retrieve a device.

Required scope: Simulation Read (roles: Air Org Administrator, Air User)

Alternative: the Air Trainee role also grants access.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequiredformat: "uuid"
A UUID string identifying this device.

Response

idstringRead-onlyformat: "uuid"
createddatetimeRead-only
modifieddatetimeRead-only
namestring<=254 characters
Name of this device. Must be unique across all devices on the same parent node. This name is delivered to the simulator to indicate a unique name and which interfaces are connected to it.
emulation_typestringRead-only

The emulation type of this device (e.g. NIC_ETHERNET).

modelstringRead-only

The hardware model this device emulates (e.g. connectx7).

number_of_portsinteger or nullRead-only

The number of ports this device emulates. Resolved at create, so it can differ from what was requested. null when the platform declares no port count.

port_typestring or nullRead-only

The port type this device emulates (e.g. ethernet). null when neither the request nor the model’s default set one.

default_splitstring or nullRead-only

The port split override this device was created with. null for a device with no OS of its own, and when it uses the platform’s own default split.

parentstringRead-onlyformat: "uuid"

The id of the emulated node this device is plugged into.

pci_configobject
The PCI slot this device occupies on its parent node.
vm_configobject
The node this device runs. Empty for emulated hardware which boots no operating system of its own.
simulator_configmap from strings to anyRead-only

Simulator-engine configuration for this device. The service-derived keys (model, number_of_ports, port_type, pci_address, pci_index) are excluded - they surface as their own fields.

has_osbooleanRead-only

Whether this device boots an operating system of its own (e.g. a DPU), rather than being emulated hardware with no OS to run (e.g. a NIC). Tells which children accept instructions, resets and console access.

Errors

403
Forbidden Error
404
Not Found Error
500
Internal Server Error