List interfaces

GET

/api/interfaces

const url = 'http://localhost:3000/api/interfaces?page=1&sort=name&order=asc';
const options = {method: 'GET', headers: {cookie: 'session=<session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:3000/api/interfaces?page=1&sort=name&order=asc' \
  --cookie session=<session>

Interfaces are device ports — same rows as /api/devices/{id}/ports, listed globally.

Authorizations

cookieAuth

Parameters

Query Parameters

page

integer

default: 1 >= 1

Page number (1-based)

pageSize

integer

>= 1 <= 10000

Rows per page. Omitted = full table, capped at 10000.

search

string

Case-insensitive substring match across name, MAC address, VLAN, description, port type

sort

string

Allowed values: name portType status linkStatus portIndex createdAt

Sort column

order

string

Allowed values: asc desc

Sort direction

deviceId

string format: uuid

Scope the list to one device

Responses

200

Success

application/json

object

data

required

Array<object>

object

required

string format: uuid

deviceId

required

string format: uuid

name

required

string

portType

required

string

default: 1000base-t

status

required

string

Allowed values: enabled disabled planned

linkStatus

required

string

Allowed values: up down unknown

peer

string

nullable

vlan

string

nullable

lldp

string

nullable

errs

integer

description

string

nullable

portGroupLabel

string

nullable

portIndex

integer

nullable

connectorType

string

nullable

speeds

Array<string>

poeStandard

string

nullable

poeWatts

integer

nullable

transceiver

string

nullable

mgig

boolean

breakoutCapable

boolean

moduleSlot

string

nullable

macAddress

string

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

total

required

integer

page

required

integer

pageSize

required

integer

hasMore

required

boolean

Example

{
  "data": [
    {
      "portType": "1000base-t",
      "status": "enabled",
      "linkStatus": "up"
    }
  ]
}

400

Invalid filter param

application/json

object

error

required

string

Example

{
  "error": "Not found"
}

401

Not authenticated

application/json

object

error

required

string

Example

{
  "error": "Not found"
}