Skip to content
SYLVE

List Network Interfaces

GET
/network/interface
curl --request GET \
  --url https://sylve.lan:8181/api/network/interface \
  --header 'Authorization: <Authorization>'

List all network interfaces on the system

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
Array<object>
object
bridgeId
string
bridgeMembers
Array<object>
object
flags
object
desc
Array<string>
raw
integer
ifmaxaddr
integer
name
string
pathCost
integer
port
integer
priority
integer
state
integer
capabilities
object
enabled
object
desc
Array<string>
raw
integer
supported
object
desc
Array<string>
raw
integer
description
string
driver
string
ether
string
flags
object
desc
Array<string>
raw
integer
groups
Array<string>
hwaddr
string
ipv4
Array<object>
object
broadcast
Array<integer>
ip
Array<integer>
netmask
string
ipv6
Array<object>
object
autoConf
boolean
deprecated
boolean
detached
boolean
ip
Array<integer>
lifeTimes
object
preferred
integer
valid
integer
prefixLength
integer
scopeId
integer
maxaddr
integer
media
object
mode
string
options
Array<string>
rawActive
integer
rawCurrent
integer
status
string
subtype
string
type
string
metric
integer
model
string
mtu
integer
name
string
nd6
object
desc
Array<string>
raw
integer
stp
object
fwddelay
integer
hellotime
integer
holdcnt
integer
ifcost
integer
maxage
integer
port
integer
priority
integer
proto
string
rootId
string
rootPriority
integer
timeout
integer
error
string
message
string
status
string
Examplegenerated
{
  "data": [
    {
      "bridgeId": "example",
      "bridgeMembers": [
        {
          "flags": {
            "desc": [
              "example"
            ],
            "raw": 1
          },
          "ifmaxaddr": 1,
          "name": "example",
          "pathCost": 1,
          "port": 1,
          "priority": 1,
          "state": 1
        }
      ],
      "capabilities": {
        "enabled": {
          "desc": [
            "example"
          ],
          "raw": 1
        },
        "supported": {
          "desc": [
            "example"
          ],
          "raw": 1
        }
      },
      "description": "example",
      "driver": "example",
      "ether": "example",
      "flags": {
        "desc": [
          "example"
        ],
        "raw": 1
      },
      "groups": [
        "example"
      ],
      "hwaddr": "example",
      "ipv4": [
        {
          "broadcast": [
            1
          ],
          "ip": [
            1
          ],
          "netmask": "example"
        }
      ],
      "ipv6": [
        {
          "autoConf": true,
          "deprecated": true,
          "detached": true,
          "ip": [
            1
          ],
          "lifeTimes": {
            "preferred": 1,
            "valid": 1
          },
          "prefixLength": 1,
          "scopeId": 1
        }
      ],
      "maxaddr": 1,
      "media": {
        "mode": "example",
        "options": [
          "example"
        ],
        "rawActive": 1,
        "rawCurrent": 1,
        "status": "example",
        "subtype": "example",
        "type": "example"
      },
      "metric": 1,
      "model": "example",
      "mtu": 1,
      "name": "example",
      "nd6": {
        "desc": [
          "example"
        ],
        "raw": 1
      },
      "stp": {
        "fwddelay": 1,
        "hellotime": 1,
        "holdcnt": 1,
        "ifcost": 1,
        "maxage": 1,
        "port": 1,
        "priority": 1,
        "proto": "example",
        "rootId": "example",
        "rootPriority": 1
      },
      "timeout": 1
    }
  ],
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}