Skip to content

get_site_health

Report per-subsystem health (wan, lan, wlan, www, vpn).

Side effects: None (read-only).

Returns one record per subsystem with subsystem, status, and subsystem-specific metrics (e.g. WAN throughput, LAN client counts).

get_site_health(controller="default")
Parameter Type Required Default Description
controller string no “default” Name of the UniFi controller to target. Defaults to "default".