Modules
Elixir client for UniFi Dream Machine APIs (Network & Protect).
Returned for a controller response that failed but is not an authentication (401/403) or rate-limit (429) failure.
Cookie + CSRF authentication for UniFi controllers.
Supervised, auto-refreshing cookie + CSRF session.
Returned when the controller responds with HTTP 401 or 403.
HTTP client wrapper for UniFi API requests.
Pure helper for annotating UniFi DPI stats with human-readable category and application names.
The error umbrella.
Pretty-prints API responses as colored ANSI tables in iex.
UniFi Network API — ACL rule management.
UniFi Network API (v2) — active DHCP leases.
UniFi Network API (v1) — alarms.
UniFi Network API (v1) — anomalies.
UniFi Network API — connected clients.
UniFi Network API (v2) — client history.
UniFi Network API (v1) — live wireless client statistics.
UniFi Network API — DNS policy management.
UniFi Network API (v1) — deep packet inspection statistics.
UniFi Network API (v2) — aggregated dashboard.
UniFi Network API — device management.
UniFi Network API (v1) — site events.
UniFi Network API — firewall zones and policies.
UniFi Network API — hotspot voucher management.
UniFi Network API (v1) — IDS / IPS detections.
UniFi Network API — system information.
UniFi Network API — network configuration.
UniFi Network API (v2) — switch port anomalies.
UniFi Network API (v1) — port-forward rules.
UniFi Network API — supporting resources.
UniFi Network API (v1) — neighbouring / rogue access points.
UniFi Network API — site management.
UniFi Network API (v2) — system log.
UniFi Network API (v2) — site topology graph.
UniFi Network API (v2) — traffic time series.
UniFi Network API — traffic matching lists.
UniFi Network API (v1) — UPS devices.
UniFi Network API (v2) — WAN / ISP health.
UniFi Network API — WiFi broadcasts.
UniFi Protect API — camera management.
UniFi Protect API — chime management.
UniFi Protect API — event log.
UniFi Protect API — light management.
UniFi Protect API — liveview management.
UniFi Protect API — NVR information.
UniFi Protect API — sensor management.
UniFi Protect API — viewer management.
Returned when the controller responds with HTTP 429.
Shared plumbing for the endpoint modules.
Raised when UnifiApi.Client.stream/3 (or stream_v1/3/stream_paged/2)
encounters an API error during pagination and the :raise_errors opt is
enabled (default behaviour through v0.4.0).
Tiny time helpers for the v1 / v2 endpoints that take unix-millisecond
timestamps (UnifiApi.Protect.Events.list/2 :start / :end,
UnifiApi.Network.Traffic.by_client/3 :start / :end, etc.).
Returned when the request never produced an HTTP response: connection refused, DNS failure, TLS handshake failure, timeout, and so on.