Skip to main content

Network endpoints

Minimum role: manager (GET /network/info and GET .../interface/{interface}/info are also readable by any role via the info-path rule).

The {interface} parameter accepts an interface name or the literal default, which resolves to the primary interface.

MethodPathRoleDescription
GET/network/infodefaultAll interfaces plus the internal container network
POST/network/reloadmanagerRe-read network state and re-check connectivity
GET/network/interface/{interface}/infodefaultSingle interface details
POST/network/interface/{interface}/updatemanagerReconfigure an interface
GET/network/interface/{interface}/accesspointsmanagerScan for wireless networks (wireless interfaces only)
POST/network/interface/{interface}/vlan/{vlan}managerCreate a VLAN on an ethernet interface

GET /network/info

Response data keys:

  • interfaces — list of interface objects (below)
  • docker — internal container network: interface, address, gateway, dns
  • host_internet — host connectivity (boolean)
  • supervisor_internet — Supervisor connectivity (boolean)

Interface object: interface, type, enabled, connected, primary, mac, ipv4, ipv6, wifi, vlan, mdns, llmnr.

  • ipv4: method, address (CIDR list), nameservers, gateway, route_metric, ready
  • ipv6: same as ipv4 plus addr_gen_mode and ip6_privacy
  • wifi: mode, auth, ssid, signal
  • vlan: id, parent

POST /network/interface/{interface}/update

At least one field is required:

FieldTypeDescription
ipv4objectaddress (list of IPv4 CIDR), method, gateway (IPv4), route_metric (int), nameservers (list of IPv4)
ipv6objectaddress (list of IPv6 CIDR), method, addr_gen_mode, ip6_privacy, gateway (IPv6), route_metric, nameservers
wifiobjectmode, auth, ssid (string), psk (string)
enabledbooleanEnable/disable the interface
mdnsstringMulticast DNS mode
llmnrstringLLMNR mode

When an ipv4/ipv6 object omits method, it defaults to static on update.

GET /network/interface/{interface}/accesspoints

Response data: accesspoints — list of mode, ssid, frequency, signal, mac. Only valid on wireless interfaces.

POST /network/interface/{interface}/vlan/{vlan}

{vlan} is the numeric VLAN ID. The body uses the same schema as interface update; ipv4/ipv6 objects default to auto method when method is omitted. Only valid on ethernet interfaces.