JWT session cookie (set by POST /api/v1/auth/login).
API key in Authorization: Bearer <key> header. Keys are configured in the bootstrap auth.api_keys list with optional roles (admin / operator / viewer / diagnostics).
Local-network bypass for the CIDR in auth.local_net — clients within it get admin for read-only methods (GET/HEAD/OPTIONS). State-changing verbs still require a credential, so a LAN client can’t mutate state without one. When auth.enabled: false (the install default) the whole middleware is bypassed and every request is admin.
For mutual TLS, terminate at a reverse proxy in front of the daemon and require client certs there.
Read or replace uplinks, wan_failover_mode (manual / auto) and wan_balance. Per-uplink fields include weight and balance.
GET
/system/wan-manager
Active/standby decisions, reasons, flap pins, timing, egress legs and balanced state.
GET
/system/wan-health
Per-uplink internet-reachability state.
Start in manual mode before enabling automatic moves. Balancing defaults to off and requires wan_failover_mode: auto plus multiple healthy balancing-eligible uplinks. PUT returns validation warnings; it does not rewrite the current wan_iface. It replaces the uplink list: send the full intended list with explicit enabled and balance values. See WAN balancing and failover.
All paths below are relative to /api/v1. Mutations require an appropriate authenticated role; UI role gating does not replace API authorization.
Method
Path
Purpose
GET/POST
/auth/users
List / create managed user accounts; admin-only.
DELETE
/auth/users/{id}
Delete a managed user and revoke its tokens.
GET/POST
/dhcp/reservations
List / create a MAC-to-IP reservation.
DELETE
/dhcp/reservations/{mac}
Remove a reservation.
GET/PUT
/interfaces/{name}/config
Per-interface address, gateway and DNS configuration.
POST
/interfaces/{name}/dhcp/{start,stop,renew}
Control the interface DHCP client; LAN and WAN uplinks are refused.
Audit-log pagination uses limit and before, with X-Total-Count in the response. Status surfaces snapshot age; routing policies expose routing, services expose installed, and DHCP leases expose reserved. cpu_temp is nullable on hosts without a thermal sensor. See Settings for live versus restart-bound changes.
Paths are relative to /api/v1. Server management is admin-only, requires sign-in and is off by default. The table is a starting point, not a substitute for reviewing a job’s plan and confirmation fields.
Method
Path
Purpose
GET/PUT
/servers/settings
Inspect or enable server management.
GET/POST
/servers
List or add server records.
GET/PUT/DELETE
/servers/{id}
Inspect, edit or remove a server.
POST
/servers/{id}/host-key/scan
Inspect available SSH host keys before pinning.
POST
/servers/{id}/host-key/confirm
Pin a reviewed host-key type and fingerprint.
POST
/servers/{id}/jobs
Queue a server job; use its idempotency key.
GET
/releases
Inspect cached releases, trust and downgrade threshold.
POST
/releases/check
Check the release site.
POST
/releases/download
Download a selected release to the cache.
POST
/releases/{version}/accept-unsigned
Explicit administrator acceptance of an unsigned-trust archive.
POST
/system/update/installer-refresh
From v2.18.2: refresh the unit and helper scripts from a verified cached release; JSON body includes version. No package installation, configuration changes or restart.
v2.18.1 embeds both release-signing keys, so signatures made by them are recognized. v2.18.0 has no embedded keys and still needs manual release acceptance. See Updates and release trust and Server management.
A policy is one source_type + source_value pair plus an ordered hops array. source_type ∈ {all, interface, vlan, subnet, device, device_group, destination, domain}. Hop types: vpn, interface, proxy, mesh_peer. An empty hops array with fail_policy: fail-closed blocks the matched traffic.