Help Needed: Omada SDN Controller v5.15.20.18 North‑bound API – Sites, Clients & Quotas

Help Needed: Omada SDN Controller v5.15.20.18 North‑bound API – Sites, Clients & Quotas

Help Needed: Omada SDN Controller v5.15.20.18 North‑bound API – Sites, Clients & Quotas
Help Needed: Omada SDN Controller v5.15.20.18 North‑bound API – Sites, Clients & Quotas
a week ago - last edited Monday

Hi all, I’m automating our captive‑portal on an on‑prem Omada SDN Controller (v5.15.20.18) and hitting roadblocks. Here’s the TL;DR:

What Works

  • GET /api/info → returns omadacId

  • POST /{omadacId}/api/v2/login → returns CSRF token + session cookie

  • POST /{omadacId}/api/v2/hotspot/extPortal/auth → successfully authenticates a client for a specified time

What Fails

  1. Listing Sites

    GET /{omadacId}/api/v2/sites
    → { "errorCode": -1, "msg": "General error." }
    
  2. Listing Connected Clients + Usage

    GET /{omadacId}/api/v2/sites/{siteId}/clients?currentPage=1&currentPageSize=1000
    → { "errorCode": -1, "msg": "General error." }
    
  3. De‑authenticating a Client
    No /deauth endpoint exists in docs.

  4. Enforcing a Data Quota
    Would like to pass totalQuota (bytes) to /hotspot/extPortal/auth but no documented support.

What I’ve Tried

  • Both internal north‑bound API v2 and attempted v3 (per apiVer in /api/info)

  • Cloud Open API (use1-omada-northbound.tplinkcloud.com) with correct client ID/secret & roles (error −44116)

Questions

  • What are the exact API endpoints (and version) to list sites and list clients + their up/down traffic?

  • How do I disconnect a captive‑portal client via API?

  • Is there a way to specify a data quota when authenticating a client?

  • Any cURL examples or JSON payload samples would be hugely appreciated!

Thanks in advance for any pointers!

  0      
  0      
#1
Options
1 Accepted Solution
Re:Help Needed: Omada SDN Controller v5.15.20.18 North‑bound API – Sites, Clients & Quotas-Solution
Monday - last edited Monday

Hi  @fulgore 

 

Please see the answers below:

 

What are the exact API endpoints (and version) to list sites and list clients + their up/down traffic?

>>>> 

Listing Sites

GET

/openapi/v1/{omadacId}/sites

 

Listing Connected Clients

GET

/openapi/v1/{omadacId}/sites/{siteId}/clients

 

How do I disconnect a captive‑portal client via API?

>>>

DELETE /openapi/v1/{omadacId}/sites/{siteId}/clients/{clientMac}

 

Is there a way to specify a data quota when authenticating a client?

>>>

It's not supported yet.

 

 

In the future, you can refer to the document on this page:

 

 

Recommended Solution
  0  
  0  
#2
Options
1 Reply
Re:Help Needed: Omada SDN Controller v5.15.20.18 North‑bound API – Sites, Clients & Quotas-Solution
Monday - last edited Monday

Hi  @fulgore 

 

Please see the answers below:

 

What are the exact API endpoints (and version) to list sites and list clients + their up/down traffic?

>>>> 

Listing Sites

GET

/openapi/v1/{omadacId}/sites

 

Listing Connected Clients

GET

/openapi/v1/{omadacId}/sites/{siteId}/clients

 

How do I disconnect a captive‑portal client via API?

>>>

DELETE /openapi/v1/{omadacId}/sites/{siteId}/clients/{clientMac}

 

Is there a way to specify a data quota when authenticating a client?

>>>

It's not supported yet.

 

 

In the future, you can refer to the document on this page:

 

 

Recommended Solution
  0  
  0  
#2
Options