Omada V2 API

Omada V2 API

49 Reply
Re:Omada V2 API
2021-08-24 00:59:54 - last edited 2022-12-29 08:36:07

Dear @DougH,

 

DougH wrote

any update on complete API documentation?

 

As I know, the complete API is planned to be standardized and updated after the Omada Controller v5.1.

 

I'll update this post once the complete API is available.

Happy New Year! Meet Us at CES 2023 | Featuring Wi-Fi 7, Omada Business Networking, VIGI Video Surveillance
  0  
  0  
#12
Options
Re:Omada V2 API
2021-09-14 11:15:06 - last edited 2022-12-29 08:36:07

Is nice that Omada is using an JSON REST API.

 

The current provided documentation is of useless as there is no information on the payload.

 

For now, I am just doing reverse engineering.

 

Use the controller from the web browser with devtools enabled. Watch the network requests while doing an action and check what payload is sent by the JS code.

 

For example the PATCH payoad for setting the fixed IP address and upload and download limits is

 

PATCH  /api/v2/sites/Default/clients/CLIENT-MAC-ADDRESS

 

{"name":"CLIENT-NAME","rateLimit":{"downEnable":true,"downLimit":10,"downUnit":1,"upEnable":true,"upLimit":10,"upUnit":1},"ipSetting":{"useFixedAddr":true,"netId":"612160610a3a7500017503b2","ip":"192.168.2.20"}}

 

I hope it helps. Happy hacking

  0  
  0  
#13
Options
Re:Omada V2 API
2021-10-28 12:59:31 - last edited 2022-12-29 08:36:07
Any updates regarding an official API? I'm running version 4.4.4 and the given API document doesn't work.
  0  
  0  
#14
Options
Re:Omada V2 API
2021-11-01 11:36:46 - last edited 2022-12-29 08:36:07

Hi,

 

Same here, definitely interested in a working non-limitating API for Omada products.

Is there any news regarding the new Omada Controller v5.1 or its related API?

Any ETA or roadmap?

 

Thanks.

Greetings.

  0  
  0  
#15
Options
Re:Omada V2 API
2021-12-01 21:22:35 - last edited 2022-12-29 08:36:07

@Fae Any updates? ... it's been months

  0  
  0  
#16
Options
Re:Omada V2 API
2021-12-03 07:19:20 - last edited 2022-12-29 08:36:07

Dear @DougH,

 

DougH wrote

Any updates? ... it's been months

 

As mentioned, the complete API is planned to be standardized and updated after the Omada Controller v5.1.

 

Controller v5.0.x hasn't been released yet, I think we may wait until the controller v5.1 has been released.

 

Thank you for your great cooperation and patience!

Happy New Year! Meet Us at CES 2023 | Featuring Wi-Fi 7, Omada Business Networking, VIGI Video Surveillance
  0  
  0  
#17
Options
Re:Omada V2 API
2021-12-03 07:46:37 - last edited 2022-12-29 08:36:07

 

Fae wrote

Controller v5.0.x hasn't been released yet, I think we may wait until the controller v5.1 has been released.

 

@Fae,

 

Yet it seems the Controller v5.0.x has been released, but on the "V4" page :

https://www.tp-link.com/fr/support/download/omada-software-controller/

 

I also noticed a big size gap on the zip file with previous version (4.4.6), does it mean many new functionalities ?

I haven't tried it yet, because only the Windows binaries have been released and my controller runs on Linux.

  0  
  0  
#18
Options
Re:Omada V2 API
2021-12-19 14:10:53 - last edited 2022-12-29 08:36:07

@DougH 

 

ate there any updates on the swagger open api documentation?  This is exactly what I am looking for to enable automation in my platform.  

  0  
  0  
#19
Options
Re:Omada V2 API
2021-12-19 14:17:10 - last edited 2022-12-29 08:36:07

@K2-Tek  I'm looking for the same thing.

 

I managed to reverse engineer the calls/data I needed using Chrome tools. You will probably have to do the same thing.

 

Until TP-Link provides something official, it's all reverse engineering. 

  0  
  0  
#20
Options
Re:Omada V2 API
2021-12-20 18:53:19 - last edited 2022-12-29 08:36:07

@sic 

There was an indication from @Fae that once v5 of the controller is officially released, there will be updated documentation.

 

I think it would be great if there were an official Python or PHP module.

 

But the good news is that once a community module is developed, we could add new features (like Radio AI) as part of the community module.

 

  0  
  0  
#21
Options

Tags

Related Articles