Set or update the browser TOKEN cookie for authentication.

Use this when authentication fails or no token is configured. To get the token: log into the UniFi controller in a browser, open DevTools (Cmd+Option+I) > Application > Cookies, and copy the TOKEN value.

Fetch system information from the UniFi controller.

Fetch health metrics for the current site.

Fetch dashboard metrics for the current site.

Fetch full controller status (system information).

Fetch information about the currently logged-in user.

Fetch all site configuration settings.

Fetch available country codes (ISO 3166-1 numeric).

Fetch currently allowed wireless channels.

Fetch switch port configurations.

Fetch VoIP extensions.

Return a mapping of device state codes to human-readable names.

Make a custom API request to the controller. Use with care.

Fetch static routing settings, optionally filtered by route ID.

List all sites managed by this UniFi controller.

Returns basic attributes for each site including _id, desc (description), and name (short name).

Fetch statistics for all sites on this controller.

Returns detailed statistics including number of devices, clients, guests, and health information for each site.

List currently online (connected) clients, or fetch a single client by MAC address.

List active clients using the v2 API with optional traffic and device filters.

List offline client history using the v2 API.

Fetch detailed statistics for a single client by MAC address.

List guest devices seen within the specified time window.

List all known client devices, including those currently offline.

Fetch all users (wired and wireless) seen within the specified time window.

Fetch client device fingerprint information.

List all devices with basic properties only.

Returns a lightweight device list with minimal attributes such as MAC address, model, type, and name. Faster than list_devices().

List devices with full detail, optionally filtered by MAC address(es).

Returns comprehensive device information including model, firmware, uptime, configuration, port tables, radio tables, and statistics.

Check the state of an RF spectrum scan for an access point.

Returns the current scan progress and results if the scan has completed.

List rogue (neighboring) access points detected by managed APs.

Returns APs seen by your network that are not part of your UniFi deployment, within the specified time window.

List known rogue access points.

Returns rogue APs that have been previously identified and marked as known in the controller.

List all hotspot operators.

List hotspot vouchers, optionally filtered by creation time.

Fetch hotspot payment records.

List WLAN configurations (wireless networks), or get a specific WLAN by ID.

List WLAN groups.

List network configurations, or get a specific network by ID.

List firewall groups, or get a specific group by ID.

List all firewall rules.

Fetch periodic statistics for site, AP, user, or gateway.

Combines all stat report endpoints into one tool. Default time ranges: 5minutes=12h, hourly=7d, daily=52w, monthly=52w.

Fetch speed test results. Defaults to past 24 hours.

Fetch IPS/IDS events. Defaults to past 24 hours.

Fetch login sessions. Defaults to past 7 days.

Fetch latest login sessions for a single client.

Fetch authorization records. Defaults to past 7 days.

Fetch site events, sorted by most recent first.

Fetch alarms, optionally filtered.

Count alarms. Optionally count only non-archived (active) alarms.

List admins for the current site.

List all admins across all sites.

Check for controller firmware updates. Returns latest known version info.

List firmware versions available or cached on the controller.

Fetch device name mappings (firmware bundles). Does not require site context.

List available auto-backups.

List all static DNS records.

List all RADIUS profiles for the current site.

List all RADIUS user accounts for the current site.

List all device tags.

Get a specific device tag by ID.

Fetch Deep Packet Inspection (DPI) statistics.

Fetch filtered DPI statistics by category or application.

Fetch port forwarding statistics.

List port forwarding rules/settings.

Fetch system log entries (v2 API). Defaults to past 7 days.

List all user groups (bandwidth profiles).

List all AP groups.