Skip to navigation
Air APIAPI ReferenceInterfaces

Retrieve an interface

View as Markdown

Retrieve an interface.

Required scope: air:simulation_read (roles: air_org_admin, air_user)

Alternative: role air_trainee 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 interface.

Response

idstringRead-onlyformat: "uuid"
createddatetimeRead-only
modifieddatetimeRead-only
nodestringRead-onlyformat: "uuid"
namestring<=15 characters
connectionstring or nullRead-onlyformat: "uuid"
A "link" between two interfaces.
splitstring or nullRead-only

Breakout factor of the interface: the split bucket of the platform port map the interface belongs to (e.g. 1x for un-split). The valid values are the split options its platform declares, so this mirrors that platform rather than a fixed vocabulary. None means the interface is not governed by a platform port map.

interface_typeenumOptional
  • DATA_PLANE_INTF - Data Plane Interface
  • PCIE_INTF - PCIe Interface between emulated nodes
  • OOB_INTF - Out of Band Management Interface
Allowed values:
mac_addressstringOptional
The MAC address of the interface. If excluded, one will be provided
outboundbooleanOptional
Whether the interface is outbound.
labelsobjectOptional

Labels which can be specified on the interface. Fields not specified in the payload schema will be completely ignored. If updating, the data provided will completely replace existing labels: attempting to PATCH specific labels will delete the other labels.

Errors

403
Forbidden Error
404
Not Found Error
500
Internal Server Error