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.
| Method | Path | Role | Description |
|---|---|---|---|
| GET | /network/info | default | All interfaces plus the internal container network |
| POST | /network/reload | manager | Re-read network state and re-check connectivity |
| GET | /network/interface/{interface}/info | default | Single interface details |
| POST | /network/interface/{interface}/update | manager | Reconfigure an interface |
| GET | /network/interface/{interface}/accesspoints | manager | Scan for wireless networks (wireless interfaces only) |
| POST | /network/interface/{interface}/vlan/{vlan} | manager | Create 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,dnshost_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,readyipv6: same asipv4plusaddr_gen_modeandip6_privacywifi:mode,auth,ssid,signalvlan:id,parent
POST /network/interface/{interface}/update
At least one field is required:
| Field | Type | Description |
|---|---|---|
ipv4 | object | address (list of IPv4 CIDR), method, gateway (IPv4), route_metric (int), nameservers (list of IPv4) |
ipv6 | object | address (list of IPv6 CIDR), method, addr_gen_mode, ip6_privacy, gateway (IPv6), route_metric, nameservers |
wifi | object | mode, auth, ssid (string), psk (string) |
enabled | boolean | Enable/disable the interface |
mdns | string | Multicast DNS mode |
llmnr | string | LLMNR 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.