ZYXEL Nebula Public API program





Along with the release of P12 in Sep. at the end of 2021, Nebula has also rolled out the first version of Nebula public API - an interface for software to interact directly with the Nebula cloud platform and Nebula-managed devices. By those APIs, Nebula users are able to programmatically monitor Nebula networks at scale. In this article describes those APIs that can be integrated from other software systems to work with the Nebula cloud management platform.
Overview
- Zyxel Nebula API is RESTful and HTTPS protected.
- Zyxel Nebula API uses API Key instead of OAUTH2 to authenticate.
- Zyxel Nebula API scope is restricted by Org level, and for the organization with Professional pack.
Support APIs (version: v0.1.19 *)
NCC |
API path |
Note |
Listing of Organizations, Sites and Devices |
/organizations |
|
License |
/license/{orgId}/complement |
|
Firmware status on all devices |
/{siteId}/firmware-status |
|
Device online status on all devices |
/{siteId}/online-status |
|
Firewall (Only for USG Flex series, ATP series) |
API path |
Note. |
Port status (WAN/LAN) |
/{siteId}/gw/{devId}/ports-status |
|
Interface status (Physical / VLAN / IP information) |
/{siteId}/gw/{devId}/ports-status |
|
Session limits |
/{siteId}/gw/{devId}/traffic-usage |
Not session limits, it is the current sessions |
Memory status |
/{siteId}/gw/{devId}/system-status |
|
CPU status |
/{siteId}/gw/{devId}/system-status |
|
Bandwidth usage |
/{siteId}/gw/{devId}/traffic-usage |
Available values : 2h, 1d, 7d |
Device Name, incl. MAC address and serial number (online/offline) |
/organizations/{orgId} |
|
NCC connectivity on/off |
/{siteId}/online-status |
Device online status on all devices, not for setting |
Switch |
API path |
Note. |
Interface status (Physical / VLAN / IP information) |
/{siteId}/sw/{devId}/ip-status |
|
MAC Table per port |
/{siteId}/sw/{devId}/l2-mac-table |
L2 MAC Table |
Full- / Half Duplex |
/{siteId}/sw/{devId}/ports-status |
|
Port speed |
/{siteId}/sw/{devId}/ports-status |
|
Neighbour info |
/{siteId}/sw/{devId}/lldp-neighbor |
LLDP |
PoE on/off on interface |
/{siteId}/sw/{devId}/poe-status |
|
PoE consumption on interface |
/{siteId}/sw/{devId}/poe-status |
|
Bandwidth usage |
/{siteId}/sw/{devId}/traffic-usage |
Available values : 2h, 1d, 7d |
Device Name, incl. MAC address and serial number (online/offline) |
/organizations/{orgId} |
|
NCC connectivity on/off |
/{siteId}/online-status |
|
WiFi |
API path |
Note. |
Interface status (Physical / VLAN / IP information) |
/{siteId}/ap/{devId}/ip-status |
No VLAN |
Authentication status (WPA2-PSK, WPA2-Enterprise, etc …) per AP/per SSID |
/{siteId}/ap/wlan-settings |
|
SSID (enabled/disabled) |
/{siteId}/ap/wlan-settings |
|
VLAN setting on interface and SSID |
/{siteId}/ap/wlan-settings |
|
Device Name, incl. MAC address and serial number (online/offline) |
/organizations/{orgId} |
|
NCC connectivity on/off |
/{siteId}/online-status |
Device online status on all devices, not for setting |
Please be noted that all APIs listed in this document could be changed frequently.
*Non-device function related APIs are not included in this table.
How to join the ZYXEL Nebula Public API program?
If you are interested in Nebula public API integration, please contact your local sales or support engineer with the following information:
- Make sure you already have Nebula devices registered with Professional pack.
- Tell us which APIs you are going to try, and share us the information about your integrated software.
- Give us the main contact window with the registered Nebula (Myzyxel.com) account.
Categories
- 8.5K All Categories
- 1.6K Nebula
- 72 Nebula Ideas
- 57 Nebula Status and Incidents
- 4.5K Security
- 227 Security Ideas
- 983 Switch
- 46 Switch Ideas
- 881 WirelessLAN
- 24 WLAN Ideas
- 5.1K Consumer Product
- 158 Service & License
- 280 News and Release
- 61 Security Advisories
- 13 Education Center
- 581 FAQ
- 263 Nebula FAQ
- 160 Security FAQ
- 76 Switch FAQ
- 75 WirelessLAN FAQ
- 7 Consumer Product FAQ
- 34 Documents
- 34 Nebula Monthly Express
- 62 About Community
- 46 Security Highlight