orgId required | string (The ID of the org) >= 16 characters |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
{- "name": "string",
- "orgId": "string",
- "mode": "PRO",
- "prevMode": "PRO",
- "licenseOverview": {
- "NCCTrialEndAt": "string",
- "NCCExpiredAt": "string"
}
}
orgId required | string (The ID of the org) >= 16 characters |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
[- {
- "siteId": "string",
- "devices": [
- {
- "devId": "string",
- "name": "string",
- "mac": "string",
- "sn": "string",
- "model": "string",
- "type": "AP"
}
]
}
]
orgId required | string (The ID of the org) >= 16 characters |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
[- {
- "devId": "string",
- "currentVersion": "string",
- "latestVersion": "string",
- "status": "N/A",
- "lastUpgradeTime": "string"
}
]
siteId required | string (Siteid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
[- {
- "devId": "string",
- "currentVersion": "string",
- "latestVersion": "string",
- "status": "N/A",
- "lastUpgradeTime": "string"
}
]
siteId required | string (Siteid) |
type | string (Type) Enum: "AP" "SW" "GW" "FIREWALL" "WWAN" "SCR" "GWH" "ACCY" |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
[- {
- "devId": "string",
- "currentStatus": "ONLINE"
}
]
siteId required | string (Siteid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
{- "sites": [
- {
- "siteId": "string",
- "subnets": [
- "string"
], - "tunnel": [
- {
- "uptime": 0,
- "status": "string",
- "lastHeartbeat": 0
}
]
}
], - "gateways": [
- {
- "peer": "string",
- "subnets": [
- "string"
], - "tunnel": [
- {
- "uptime": 0,
- "status": "string",
- "lastHeartbeat": 0
}
]
}
], - "remoteAps": [
- {
- "devId": "string",
- "uptime": 0,
- "status": "string",
- "lastHeartbeat": 0
}
], - "cleints": [
- {
- "username": "string",
- "hostname": "string",
- "publicIPv4": "192.168.0.1",
- "asssignedIPv4": "192.168.0.1"
}
]
}
This API returns the last 2 hours data of site-wide clients.
siteId required | string (Siteid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
[- "mac_address"
]
[- {
- "macAddress": "string",
- "ipv4Address": "192.168.0.1",
- "vlan": 0,
- "lastSeen": 0,
- "connectedTo": "string",
- "status": "ONLINE",
- "firstSeen": 0,
- "description": "string",
- "osHostname": {
- "os": "string",
- "hostname": "string"
}, - "manufacturer": "string"
}
]
This API returns the last 2 hours data of AP clients.
siteId required | string (Siteid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
[- "mac_address"
]
[- {
- "macAddress": "string",
- "ipv4Address": "192.168.0.1",
- "lastSeen": 0,
- "connectedTo": "string",
- "firstSeen": 0,
- "description": "string",
- "osHostname": {
- "os": "string",
- "hostname": "string"
}, - "manufacturer": "string",
- "ssid": {
- "name": "string",
- "security": "OPEN"
}, - "wifiStation": {
- "status": "ONLINE",
- "vlan": 0,
- "signal": 0,
- "band": "band24",
- "channel": 0
}
}
]
Instruct the device to ping the target address. The token must be null to initialize the ping task, and then use the returned token to fetch the results.
siteId required | string (Siteid) |
devId required | string (Devid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
target required | string (Target) |
Token (string) or Token (null) (Token) |
{- "target": "string",
- "token": "string"
}
{- "token": "string",
- "isDone": true,
- "results": [
- {
- "seq": 0,
- "loss": true,
- "timestamp": 0,
- "elapsedTime": 0
}
]
}
Instruct the switch to perform cable diagnostics test.
siteId required | string (Siteid) |
devId required | string (Devid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
ports required | Array of integers (Ports) |
{- "ports": [
- 0
]
}
{- "ports": [
- {
- "port": 0,
- "results": [
- {
- "channel": "string",
- "pairStatus": "string",
- "pairLength": "string",
- "pairDistanceToFault": "string"
}
]
}
]
}
This API returns the last 2hr/1d/7d/30d data of device connectivity status
siteId required | string (Siteid) |
devId required | string (Devid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
required | ClientPeriod (string) or null |
{- "period": "2h"
}
[- {
- "begin_time": 0,
- "end_time": 0,
- "status": "string"
}
]
This API returns the last 2hr/1d/7d/30d data of site-wide clients.
Response data key is macAddress.
siteId required | string (Siteid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
required | ClientPeriod (string) or null default is 2h |
featrues required | Array of strings (Featrues) Items Enum: "mac_address" "ipv4" "vlan" "last_seen" "connected_device_id" "status" "first_seen" "description" "os_hostname" "manufacturer" |
{- "period": "2h",
- "featrues": [
- "mac_address"
]
}
{- "KeyFields": [
- "macAddress"
], - "data": [
- {
- "macAddress": "string",
- "ipv4Address": "192.168.0.1",
- "vlan": 0,
- "lastSeen": 0,
- "connectedTo": "string",
- "status": "ONLINE",
- "firstSeen": 0,
- "description": "string",
- "osHostname": {
- "os": "string",
- "hostname": "string"
}, - "manufacturer": "string"
}
]
}
This API returns the last 2hr/1d/7d/30d data of AP clients.
Response data key is macAddress.
siteId required | string (Siteid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
required | ClientPeriod (string) or null default is 2h |
featrues required | Array of strings (Featrues) Items Enum: "mac_address" "ipv4" "last_seen" "connected_device_id" "first_seen" "description" "os_hostname" "manufacturer" "ssid" "wifi_sta" "user" "upload" "download" |
{- "period": "2h",
- "featrues": [
- "mac_address"
]
}
{- "KeyFields": [
- "macAddress"
], - "data": [
- {
- "macAddress": "string",
- "ipv4Address": "192.168.0.1",
- "lastSeen": 0,
- "connectedTo": "string",
- "firstSeen": 0,
- "description": "string",
- "osHostname": {
- "os": "string",
- "hostname": "string"
}, - "manufacturer": "string",
- "ssid": {
- "name": "string",
- "security": "OPEN"
}, - "wifiStation": {
- "status": "ONLINE",
- "vlan": 0,
- "signal": 0,
- "band": "band24",
- "channel": 0
}, - "user": "string",
- "upload": 0,
- "download": 0
}
]
}
This API returns the last 2hr/1d/7d/30d data of SW clients.
Response data key is macAddress and vlan.
siteId required | string (Siteid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
required | ClientPeriod (string) or null default is 2h |
featrues required | Array of strings (Featrues) Items Enum: "mac_address" "ipv4" "last_seen" "connected_device_id" "first_seen" "description" "manufacturer" "vlan" "lldp_info" |
{- "period": "2h",
- "featrues": [
- "mac_address"
]
}
{- "KeyFields": [
- "macAddress"
], - "data": [
- {
- "macAddress": "string",
- "ipv4Address": "192.168.0.1",
- "lastSeen": 0,
- "connectedTo": "string",
- "firstSeen": 0,
- "description": "string",
- "manufacturer": "string",
- "vlan": 0,
- "lldp": "string"
}
]
}
This API returns the last 2hr/1d/7d/30d data of GW clients.
Firewall Respone data key is macAddress and ipv4Address and interface.
SCR Respone data key is macAddress.
siteId required | string (Siteid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
required | ClientPeriod (string) or null default is 2h |
featrues required | Array of strings (Featrues) Items Enum: "mac_address" "ipv4" "last_seen" "connected_device_id" "first_seen" "description" "os_hostname" "manufacturer" "interface" |
{- "period": "2h",
- "featrues": [
- "mac_address"
]
}
{- "KeyFields": [
- "macAddress"
], - "data": [
- {
- "macAddress": "string",
- "ipv4Address": "192.168.0.1",
- "lastSeen": 0,
- "connectedTo": "string",
- "firstSeen": 0,
- "description": "string",
- "osHostname": {
- "os": "string",
- "hostname": "string"
}, - "manufacturer": "string",
- "interface": "string"
}
]
}
This API returns the current IP status (instead of configuration) of AP interfaces.
siteId required | string (Siteid) |
devId required | string (Devid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
[- {
- "interface": "string",
- "ipv4Type": "STATIC",
- "ipv4Address": "192.168.0.1",
- "ipv4Netmask": "192.168.0.1",
- "ipv4Gateway": "192.168.0.1",
- "DNSServers": [
- "192.168.0.1"
], - "vlan": 0
}
]
Note: This API always returns 8 SSIDs.
siteId required | string (Siteid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
[- {
- "name": "string",
- "enabled": true,
- "security": "OPEN",
- "band": [
- "band24"
], - "visibility": true,
- "vlan": 0,
- "wpaKey": "string",
- "captivePortal": "DISABLED"
}
]
Note: currently this API only supports PSK For [PATCH] method on wlan-setting API, it will only update the SSID Pre-Shared-Key (PSK), no matter the SSID security mode is WPA2/3 or not.
siteId required | string (Siteid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
id required | integer (Id) ( 0 .. 8 ] Index from 1 to 8 |
wpaKey required | string (Wpakey) |
[- {
- "id": 8,
- "wpaKey": "string"
}
]
{- "status": 0,
- "message": "string"
}
Logout AP users in the site. Every AP will be instructed to logout the users.
siteId required | string (Siteid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
[- "string"
]
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
siteId required | string (Siteid) |
devId required | string (Devid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
[- {
- "lldpRemLocalPortNum": "string",
- "lldpRemPortId": "string",
- "lldpRemPortDesc": "string",
- "lldpRemSysName": "string",
- "lldpRemChassisId": "string",
- "lldpRemChassisIdSubtype": "CHASSIS_COMPONENT"
}
]
This API returns the current IP status (instead of configuration) of Switch. Currently, only one IP will be returned in the array.
siteId required | string (Siteid) |
devId required | string (Devid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
[- {
- "interface": "string",
- "ipv4Type": "STATIC",
- "ipv4Address": "192.168.0.1",
- "ipv4Netmask": "192.168.0.1",
- "ipv4Gateway": "192.168.0.1",
- "DNSServers": [
- "192.168.0.1"
], - "vlan": 0
}
]
siteId required | string (Siteid) |
devId required | string (Devid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
[- {
- "portNum": 0,
- "enabled": true,
- "trunk": true,
- "portVid": 0,
- "allowedVLAN": [
- "string"
], - "hasPse": true,
- "pseEnabled": true
}
]
siteId required | string (Siteid) |
devId required | string (Devid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
portNum required | integer (Portnum) |
enabled required | boolean (Enabled) |
trunk required | boolean (Trunk) |
portVid required | integer (Portvid) |
allowedVLAN required | Array of strings (Allowedvlan) |
required | Pseenabled (boolean) or Pseenabled (null) (Pseenabled) |
{- "portNum": 0,
- "enabled": true,
- "trunk": true,
- "portVid": 0,
- "allowedVLAN": [
- "string"
], - "pseEnabled": true
}
{- "status": 0,
- "message": "string"
}
siteId required | string (Siteid) |
devId required | string (Devid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
[- {
- "budget": 0,
- "currentUsage": 0,
- "ports": [
- {
- "portNum": 0,
- "enabled": true,
- "usage": 0
}
]
}
]
siteId required | string (Siteid) |
devId required | string (Devid) |
period | string (Period) Default: "1d" Enum: "2h" "1d" "7d" |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
[- {
- "devId": "string",
- "uplinkTxUsage": 0,
- "uplinkRxUage": 0
}
]
siteId required | string (Siteid) |
devId required | string (Devid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
startTimestamp required | integer (Starttimestamp) unit: Unix timestamp (ms) |
endTimestamp required | integer (Endtimestamp) unit: Unix timestamp (ms) |
{- "startTimestamp": 0,
- "endTimestamp": 0
}
[- {
- "timestamp": 0,
- "category": "string",
- "devId": "string",
- "mac": "string",
- "message": "string",
- "priority": "string",
- "tag": "string"
}
]
siteId required | string (Siteid) |
devId required | string (Devid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
[- {
- "portNumber": "string",
- "portGroup": "string",
- "linkSpeed": "string"
}
]
siteId required | string (Siteid) |
devId required | string (Devid) |
period | string (Period) Default: "1d" Enum: "2h" "1d" "7d" |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
[- {
- "interface": "string",
- "uplinkTxUsage": 0,
- "uplinkRxUage": 0
}
]
siteId required | string (Siteid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
startTimestamp required | integer (Starttimestamp) unit: Unix timestamp (ms) |
endTimestamp required | integer (Endtimestamp) unit: Unix timestamp (ms) |
{- "startTimestamp": 0,
- "endTimestamp": 0
}
[- {
- "timestamp": 0,
- "category": "string",
- "devId": "string",
- "mac": "string",
- "message": "string",
- "srcIpv4": "192.168.0.1",
- "srcPort": 0,
- "dstIpv4": "192.168.0.1",
- "dstPort": 0
}
]
siteId required | string (Siteid) |
devId required | string (Devid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
{- "oneToOne": [
- {
- "enabled": true,
- "name": "string",
- "interface": "string",
- "publicIPv4": "192.168.0.1",
- "privateIPv4": "192.168.0.1",
- "inbound": [
- {
- "enabled": true,
- "protocol": 0,
- "port": [
- "string"
], - "remote": [
- "string"
]
}
]
}
], - "virtualServer": [
- {
- "enabled": true,
- "description": "string",
- "interface": "string",
- "protocol": 0,
- "publicIPv4": "192.168.0.1",
- "publicPorts": [
- "string"
], - "serverIPv4": "192.168.0.1",
- "serverPorts": [
- "string"
], - "allowedRemote": [
- "string"
]
}
]
}
siteId required | string (Siteid) |
devId required | string (Devid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
{- "wan": [
- {
- "id": "string",
- "enabled": true,
- "portGroupId": "string",
- "interface": "string",
- "ipv4Type": "STATIC",
- "ipv4Address": "192.168.0.1",
- "ipv4Netmask": "192.168.0.1",
- "ipv4Gateway": "192.168.0.1",
- "DNSServers": [
- "192.168.0.1"
], - "vlan": 0
}
], - "lan": [
- {
- "id": "string",
- "enabled": true,
- "portGroupId": "string",
- "interface": "string",
- "ipv4Type": "STATIC",
- "ipv4Address": "192.168.0.1",
- "ipv4Netmask": "192.168.0.1",
- "guestZone": true
}
]
}
This API returns the Mobile Router WWAN Status.
siteId required | string (Siteid) |
devId required | string (Devid) |
X-ZyxelNebula-API-Key required | string (X-Zyxelnebula-Api-Key) |
{- "ipv4Address": "192.168.0.1",
- "imei": "string",
- "iccid": "string",
- "rsrp": 0
}