UnifiApi.Network.WAN (UnifiApi v0.4.0)

Copy Markdown View Source

UniFi Network API (v2) — WAN / ISP health.

Reports gateway WAN status, ISP up/down state, load-balancing config, and SLA monitoring data.

Requires cookie + CSRF authentication. See UnifiApi.Auth.Cookie.

Endpoints exposed

Summary

Functions

Returns the enriched WAN configuration: per-WAN type, identifiers, and derived state.

Returns ISP reachability and latency status for a specific WAN.

Returns the multi-WAN load-balancing configuration and current per-WAN weights.

Returns SLA monitoring data for the site's WAN connections.

Functions

enriched_config(client, site_id)

@spec enriched_config(Req.Request.t(), String.t()) ::
  {:ok, term()} | {:error, UnifiApi.Error.t()}

Returns the enriched WAN configuration: per-WAN type, identifiers, and derived state.

isp_status(client, site_id, wan_id)

@spec isp_status(Req.Request.t(), String.t(), String.t()) ::
  {:ok, term()} | {:error, UnifiApi.Error.t()}

Returns ISP reachability and latency status for a specific WAN.

load_balancing(client, site_id)

@spec load_balancing(Req.Request.t(), String.t()) ::
  {:ok, term()} | {:error, UnifiApi.Error.t()}

Returns the multi-WAN load-balancing configuration and current per-WAN weights.

slas(client, site_id)

@spec slas(Req.Request.t(), String.t()) ::
  {:ok, term()} | {:error, UnifiApi.Error.t()}

Returns SLA monitoring data for the site's WAN connections.