List all sites configured on the Omada controller.

List provisioned network devices for a specific site.

List network clients connected to a site.

Fetch detailed information for a specific Omada device.

Fetch detailed information for a specific switch stack.

Fetch details for a specific Omada client.

Search for devices globally across all sites the user has access to. Returns devices matching the search key.

Query statistics for global adopted devices with pagination and filtering. Supports fuzzy search by MAC address, name, model, or serial number, and filtering by tag or device series type (0: basic, 1: pro).

Get the most active clients in a site, sorted by total traffic. Returns client name, MAC address, type, model, wireless status, and total traffic. This is a dashboard endpoint that provides a quick overview of top clients by traffic usage.

Get client activity statistics over time from the dashboard. Returns time-series data showing new, active, and disconnected clients (both wireless/EAP and wired/switch) for each time snapshot. Useful for monitoring client connection trends and activity patterns.

Get client past connection list with historical connection data. Returns information about clients that have previously connected to the network, including connection timestamps, traffic data, duration, and device details. Supports pagination, filtering by time range and guest status, sorting by last seen time, and fuzzy search by name/MAC/SSID.

Get the global view threat management list. Returns paginated threat information including severity, source/destination IPs, countries, classification, and more.

Get internet configuration information for a site, including WAN settings and connectivity details.

Get port forwarding status and rules for a site. Retrieves either User-configured or UPnP-discovered port forwarding rules. Both page and pageSize parameters are required by the API. Call this tool twice (once with type="User" and once with type="UPnP") to get complete port forwarding information.

Get the list of LAN networks configured in a site, including VLAN settings, IP ranges, and DHCP configuration.

Get the list of LAN profiles configured in a site. LAN profiles define network settings that can be applied to switch ports.

Get the list of WLAN groups configured in a site. WLAN groups contain SSIDs and define wireless network settings. Use the wlanId from this list to call getSsidList.

Get the list of SSIDs (wireless networks) configured in a WLAN group. Requires wlanId which can be obtained from getWlanGroupList. Use the ssidId from this list to call getSsidDetail.

Get detailed information for a specific SSID (wireless network), including security settings, rate limits, scheduling, and advanced configurations. Requires wlanId (from getWlanGroupList) and ssidId (from getSsidList).

Get firewall configuration and rules for a site, including ACL rules, IP groups, and security policies.

Get all ports for a switch by its MAC address, including status, profile, PoE, link speed, and STP state.

Get firmware information for a device including current version and available updates.

List paginated events for a site (alerts, warnings, system events).

List paginated logs for a site (system logs, configuration changes).

List firewall ACL rules for a site (access control lists for inter-VLAN traffic, etc.).

List IP/port groups configured in a site. Groups can be used in firewall ACL rules. Requires the internal web UI API (OMADA_WEB_USERNAME/OMADA_WEB_PASSWORD).

List static routes configured for a site.

Get full switch info including portList array by MAC address.

Get cable test results for a switch. Run startCableTest first.

Get switch networks / VLAN trunking configuration for a switch.

Create a new LAN network with VLAN, gateway/subnet, and DHCP settings.

Update an existing LAN network configuration including VLAN, gateway/subnet, and DHCP settings.

Delete a LAN network by its network ID.

Create a new LAN profile with native/tagged network assignments and port settings.

Update an existing LAN profile configuration including network assignments and port settings.

Update firewall settings for a site. Pass the same shape returned by getFirewallSetting (broadcastPing, sendRedirects, synCookies, etc.).

Create a firewall ACL rule for inter-VLAN isolation or traffic control. Use listFirewallAcls first to see the expected rule shape.

Delete a firewall ACL rule by its ID.

Update a switch port configuration (profile, PoE, speed, STP, isolation, etc.).

Update client settings such as display name, static IP, and rate limits.

Set switch networks / VLAN trunking configuration for a switch.

Assign a LAN profile to a single switch port.

Enable or disable PoE on a single switch port. 1=on (802.3at/af), 0=off.

Set the name of a single switch port (1-128 characters).

Enable or disable a single switch port. 0=off, 1=on.

Enable or disable profile override on a single switch port.

Batch enable or disable profile override on multiple switch ports.

Batch enable or disable PoE on multiple switch ports. 1=on (802.3at/af), 0=off.

Batch enable or disable multiple switch ports. 0=off, 1=on.

Batch set names on multiple switch ports. Each entry specifies a port number and name (1-128 chars).

Start a cable test on a switch. Use getCableTestResults to retrieve results after completion.

Reboot a network device by its MAC address.

Adopt a pending device by its MAC address into the site.

Block a client device by its MAC address, preventing it from accessing the network.

Unblock a previously blocked client device by its MAC address, restoring network access.

Force a client to reconnect to the network by its MAC address.

Set the LED on/off/site-default for a device by its MAC address.

Start a firmware upgrade for a device. Use getFirmwareDetails first to check for available updates.

Connect or disconnect a gateway WAN port.

List reboot schedules for a site, including which devices each one targets and the next execution time. nextExecute is a millisecond epoch in UTC — compare it against the site timezone, since a site left on UTC will run schedules an hour early during summer time. Requires OMADA_WEB_USERNAME/OMADA_WEB_PASSWORD.

Create a reboot schedule targeting specific devices. Useful for capping the memory creep that makes access points degrade over long uptimes. Times are interpreted in the site timezone, so verify that first with getSiteSettings. Requires OMADA_WEB_USERNAME/OMADA_WEB_PASSWORD.

Update an existing reboot schedule. This is a replace (PUT), not a merge: read the schedule with listRebootSchedules, change the fields you want, and send the whole object back. Requires OMADA_WEB_USERNAME/OMADA_WEB_PASSWORD.

Delete a reboot schedule by id. Requires OMADA_WEB_USERNAME/OMADA_WEB_PASSWORD.

List PoE schedules for a site. PoE schedules cut and restore power to switch ports on a time range, which power-cycles whatever is attached. Requires OMADA_WEB_USERNAME/OMADA_WEB_PASSWORD.

Create a PoE schedule. Prefer a reboot schedule where the target is an Omada-managed device — cutting PoE is a hard power cut, and it will also drop anything else sharing the port, including a PoE-powered controller. Requires OMADA_WEB_USERNAME/OMADA_WEB_PASSWORD.

Update an existing PoE schedule (replace, not merge). Requires OMADA_WEB_USERNAME/OMADA_WEB_PASSWORD.

Delete a PoE schedule by id. Requires OMADA_WEB_USERNAME/OMADA_WEB_PASSWORD.

List time range profiles for a site. These are the reusable schedule primitive that PoE schedules, WLAN schedules and ACL rules bind to. Requires OMADA_WEB_USERNAME/OMADA_WEB_PASSWORD.

Get full site settings: timezone and DST, NTP servers, mesh, band steering, airtime fairness, roaming, LED, auto-upgrade, alerts and remote logging. Check the timezone here before trusting any schedule time. Requires OMADA_WEB_USERNAME/OMADA_WEB_PASSWORD.

Patch site settings. Only the sections supplied are changed. Read the current values with getSiteSettings first. Requires OMADA_WEB_USERNAME/OMADA_WEB_PASSWORD.

Set the site timezone, handling the region and scenario fields the controller requires alongside it. IMPORTANT: on firmware tested, the timezone alone does NOT make schedules observe daylight saving. Omada keeps DST as a separate site setting (site.dst.enable, with manual recurring start/end rules) which is off by default, so a controller runs on standard offset year-round and a "06:00" schedule fires at 07:00 wall-clock during summer time. Check site.dst via getSiteSettings, and treat a schedule's notInDst flag as confirmation. Requires OMADA_WEB_USERNAME/OMADA_WEB_PASSWORD.

Execute an arbitrary Omada API call. Use this for any endpoint not covered by other tools. Path is relative (e.g. "/sites/{siteId}/setting/firewall/acls"). The omadacId prefix is added automatically.