Network Edge APIs | Equinix Product Documentation

Get Device Interfaces

Request

Returns the status of the interfaces of a device. You must pass the unique Id of the device as a path parameter.

Security

BearerAuth

Path

uuidstringrequired

uuid

Example:3da0a663-20d9-4b8f-8c5d-d5cf706840c8

Payload

// No request payload

Responses

Success

Bodyapplication/json

Array [

idnumber

Interface ID.

Example:1

namestring

Interface name.

Example:"ethernet1"

statusstring

Interface status

Enum:"ASSIGNED""AVAILABLE""RESERVED"

Example:"ASSIGNED"

operationStatusstring

Interface operational status

Enum:"UP""DOWN"

Example:"DOWN"

macAddressstring

MAC address.

Example:"fa16.3e1c.a8d8"

ipAddressstring

IP address.

Example:"2.2.2.2"

assignedTypestring

Assigned type

Enum:"EQUINIX_MANAGED""USER_MANAGED"

Example:"EQUINIX_MANAGED"

typestring

The type of interface (e.g., DATA, MGMT, WAN)

Enum:"DATA""MGMT""WAN"

Example:"DATA"

]

Response

[
  {
    "id": 1,
    "name": "ethernet1",
    "status": "ASSIGNED",
    "operationStatus": "DOWN",
    "macAddress": "fa16.3e1c.a8d8",
    "ipAddress": "2.2.2.2",
    "assignedType": "EQUINIX_MANAGED",
    "type": "DATA"
  }
]