Expand Nebula OpenAPI for Advanced Gateway Monitoring and Diagnostics

Hello Zyxel Team,

We are developing a centralized monitoring platform for Zyxel firewalls across multiple customer organizations, using the Nebula OpenAPI.

During integration with USG FLEX and ATP gateways, we identified several monitoring capabilities that are either unavailable or insufficiently documented in the current public API.

We would like to propose the following enhancements.

1. System Uptime

Endpoint: GET /v1/nebula/{siteId}/gw/{devId}/system-status

Please expose the actual system uptime, equivalent to the value displayed in the firewall's local GUI, rather than the SNMP management subsystem uptime.

2. Last Communication with Nebula

Endpoint: GET /v1/nebula/{siteId}/online-status

Please provide the UTC timestamp of the gateway's last successful communication with the Nebula cloud.

This would help determine how long a disconnected gateway has been offline.

3. Timestamped Traffic History

Endpoint: GET /v1/nebula/{siteId}/gw/{devId}/traffic-usage

The current API provides aggregated traffic usage for predefined periods, but not timestamped measurements.

We would appreciate historical upload/download data with timestamps, preferably at hourly or finer granularity, to make it possible to render a graph similar to the one in the GUI.

Clarification of the traffic units and transmission/reception semantics would also be helpful.

4. Gateway Event Log Severity

Endpoint: POST /v1/nebula/{siteId}/gw/event-logs

Please expose the severity or priority of each gateway event and indicate whether it is classified as an alert. It would also be helpful if the logs came decoded, with user-friendly messages, together with a full-log field if we need any other information about it.

The firewall's local GUI distinguishes alerts from ordinary logs, but this information is not available in the gateway event logs response.

5. Event Log Pagination and Filtering

The gateway event logs endpoint currently lacks documented pagination parameters.

Retrieving large time ranges can produce extremely large responses.

We suggest adding cursor-based pagination, a configurable result limit, and optional filtering by gateway devId.

6. Maximum Concurrent Sessions

Endpoint: GET /v1/nebula/{siteId}/gw/{devId}/system-status

Please expose the effective maximum concurrent session capacity of the gateway, alongside the existing active session count.

This would help determine session capacity utilization.

7. Configuration Change Audit

Please provide an API-accessible audit trail of gateway configuration changes, including timestamps, responsible administrators, affected configuration sections, and change actions, while protecting sensitive information.

8. Hardware Health and Ethernet Port Status

Endpoint: GET /v1/nebula/{siteId}/gw/{devId}/ports-status

Please clarify the distinction between No Link and Link Down, and consider exposing explicit administrative and operational interface states.

Hardware health indicators corresponding to PWR/SYS/USB, where supported, would also be valuable.

Why this matters

These capabilities would allow MSPs and integrators to build more complete and reliable monitoring solutions without relying on additional SSH/SNMP integrations or inferring information that the API does not explicitly provide.

We would appreciate confirmation if any of these fields are already available through other documented endpoints.

Thank you for considering these improvements!