Skip to content

API reference ​

Every operation in the bundled Omada Open API spec: 2450 operations in 163 categories (201 PUT, 214 DELETE, 1061 GET, 665 POST, 309 PATCH).

This reference is generated from spec/omada-openapi.json. Your controller may have a few more or fewer operations depending on its firmware; at runtime the server uses your controller's own spec when it can.

Use the search box (top of the page) to find an operation by name, or pick a category:

CategoryOperations
Access Control3
Access Control (Template)3
ACL21
ACL (Template)14
Ap79
Application Control45
Arp Detection8
Attack Defense4
Attack Defense (Template)3
Audit Log8
Audit Log (Template)2
Authentication20
Authentication (Template)11
Authorized Client9
Backup and Restore13
Backup schedule2
Bandwidth Control7
Bandwidth Control (Template)7
Batch OpenAPI1
Bluetooth24
Bluetooth(Template)9
CertProfiles11
CertProfiles (Template)9
CLI11
CLI (Template)6
Client38
Client Insight21
Cloud User10
Cluster1
Controller Settings23
Customer9
Dashboard32
Data Export1
Device82
Device Management Setting2
DHCP Reservation11
Dhcp Snooping7
Disable Nat4
DNS10
DNS (Template)10
EoGRE Tunnel2
Firewall4
Firewall (Template)3
Firmware33
Form Auth Data11
Gateway40
Gateway (Template)13
Gateway QoS13
Gateway QOS (Template)13
Global Dashboard Overview1
Global Security11
Health21
History Data Retention4
Hotspot Operators5
IDS/IPS11
IDS/IPS (Template)6
Incident (Template)4
Incidents21
Insight40
Intelli Recover Client6
Intelli Recover Device8
IP-MAC Binding9
IP-MAC Binding (Template)7
IPTV6
IPTV (Template)4
Lan Multicast4
Lan Multicast (Template)4
License7
Local User9
Log22
Log (Template)3
MAC Filtering7
MAC Filtering (Template)7
mDNS4
mDNS (Template)4
Mlag8
MSP Batch OpenAPI1
MSP Device7
MSP History Data Retention2
Msp License7
Msp Log15
Msp Osw Port Layout1
Msp setting20
MSP Site2
MSP SSO9
MSP User and Role22
Msp Webhook Setting6
NAT10
NAT (Template)11
Network Analyze7
Network Report2
OLT21
OLT DBA5
OLT Gem Mapping5
OLT Gem Port5
OLT Line Profile5
OLT ONT Port4
OLT ONU Management11
OLT ONU Register21
OLT Pon Port6
OLT Service Port14
OLT Service Port Profile10
OLT Service Profile5
OLT T-cont5
OLT Traffic Profile5
OSPF13
Osw Port Layout1
OUI Based VLAN16
OUI Based VLAN (Template)15
Profiles65
Profiles (Template)55
Quick Action1
Remote Access9
Report v212
Routing10
Routing (Template)9
Rrm5
Schedule18
Schedule (Template)8
SD-WAN16
Service (Template)2
Session Limit7
Session Limit (Template)7
SIM38
SIM (Template)7
Site27
Site Configuration33
Site Template35
Site Template Configuration25
SNMP3
SNMP (Template)2
SSH2
SSH (Template)2
SSL VPN35
SSO9
Stack64
Statistic9
Switch78
Switch (Template)34
Switch QoS17
System Settings2
Threat Management4
Topology20
UPnP2
UPnP (Template)2
URL Filtering9
URL Filtering (Template)6
User and Role20
VoIP56
VoIP (Template)23
Voucher29
VPN66
VRRP4
Webhook Setting6
Wi-Fi Calling Traffic2
Wired Network100
Wired Network (Template)63
Wireguard VPN10
Wireless IDS/IPS4
Wireless IDS/IPS (Template)4
Wireless Network50
Wireless Network (Template)43
WLAN Optimization26

Released under the MIT License. Not affiliated with or endorsed by TP-Link.