Updated on December 12, 2023:

 

I would like to provide updated information related to the Omada API here.

 

1. About Omada API Documentation

Currently, Omada API can be classified into Web API and Open API, whose documentations are different.

 

• The attachment is the latest Omada Web API documentation, which is mainly applicable to Omada SDN Controller v5.9.

    Notes:

    1)  Web API may change with Omada Controller version iterations. The attached Web API documentation shall only be used as

         a reference to other Omada SDN Controller versions.

    2)  For API samples, please refer to API and Code Sample for External Portal Server (Omada Controller 5.0.15 or above)

 

• Here is the online documentation for Omada Open API: https://use1-omada-northbound.tplinkcloud.com/doc.html#/home

    Notes:

    1)  All Omada Pro versions support Open API.

    2)  Omada Software/Hardware Controller support Open API since Controller v5.12.

    3)  Omada Cloud-Based Controller (CBC) does NOT support Open API yet (as of December 12, 2023).

 

2. About Omada API Version

 

The “v2” mentioned in the API request example “${OMADA_URL}/${CONTROLLER_ID}/api/v2/users/…” is actually the version of the Omada Web API. Please note that Omada Open API currently only has the V1 version.

 

 

Edited on April 18, 2023:

 

Hi there,

 

Please find the latest API documents in the following newest reply posts.

 

Any further questions related to the API,

please feel free to Start a New Thread and add the "API" tag to get help from TP-Link experts and fellow customers alike. 

 

To get better assistance, you may check Tips For Efficiently Reporting an Issue In The Community. See you soon in the forums!