Nebula - Integración de API (Programa de API Pública de Nebula)

Junto con el lanzamiento de P12 en septiembre de 2021, Nebula también ha implementado la primera versión de la API pública de Nebula, una interfaz para que el software interactúe directamente con la plataforma en la nube de Nebula y los dispositivos administrados por Nebula. A través de estas API, los usuarios de Nebula pueden monitorear programáticamente las redes de Nebula a gran escala. En este artículo se describen esas API que pueden integrarse desde otros sistemas de software para trabajar con la plataforma de gestión en la nube de Nebula.

Las integraciones de API en Nebula se realizan a nivel de ORGANIZACIÓN, y la organización necesita el paquete Professional.
La API de Zyxel Nebula es RESTful y está protegida por HTTPS.
La API de Zyxel Nebula utiliza una clave de API en lugar de OAUTH2 para autenticarse.

Puede configurarse desde:

Site-wide -> General Settings -> API access

APIs compatibles (versión: v0.1.19 *)

NCC	API path	Note
Listing of Organizations, Sites and Devices	​/organizations /organizations/{orgId} /organizations/{orgId}/sites /organizations/{orgId}/sites/devices
License	/license/{orgId}/complement /license/{orgId}/claim /license/{orgId}/claim-result
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} /organizations/{orgId}/sites/devices
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 /{siteId}/sw/{devId}/ports-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} /organizations/{orgId}/sites/devices
NCC connectivity on/off	/{siteId}/online-status

WiFi	API path	Note.
Interface status (Physical / VLAN / IP information)	/{siteId}/ap/{devId}/ip-status /{siteId}/ap/{devId}/ports-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} /organizations/{orgId}/sites/devices
NCC connectivity on/off	/{siteId}/online-status	Device online status on all devices, not for setting

Ten en cuenta que todas las API enumeradas en este documento podrían cambiar con frecuencia.

*Las API no relacionadas con funciones de dispositivos no se incluyen en esta tabla.

Cómo unirse al programa de API pública de ZYXEL Nebula:
Si estás interesado en la integración de la API pública de Nebula, por favor contacta a tu ingeniero de ventas o soporte local con la siguiente información:

Asegúrate de que ya tienes dispositivos Nebula registrados con el paquete Professional.
Indícanos qué APIs vas a probar y compártenos la información sobre tu software integrado.
Proporciónanos el contacto principal con la cuenta Nebula registrada (Myzyxel.com).

Fuente:

• https://support.zyxel.eu/hc/en-us/articles/10424641227666-Nebula-API-Integration-Nebula-Public-API-Program
• https://community.zyxel.com/en/discussion/12536/zyxel-nebula-openapi
• https://www.zyxel.com/es/es/products/management-and-reporting/cloud-networking-management-nebula-control-center/nebula-open-api