Status
POST /api/status.cellularModule.temperature
Obtain the current temperature of the cellular module in degrees Celsius.
Available in 8.4.1 or later
Input Parameters
| Field | Type | Required | Description |
|---|---|---|---|
connId | number | ✅ | WAN connection ID of the cellular module |
Response
| Field | Type | Description |
|---|---|---|
temperature | integer | Temperature in degrees Celsius |
cURL Example
curl -b cookies.txt -H "Content-Type: application/json" \
-X POST -d '{"connId":4}' \
http://192.168.1.1/api/status.cellularModule.temperature
{
"stat": "ok",
"response": {
"temperature": 41
}
}
GET /api/status.client
Retrieve client details including name, MAC address, IP address, signal information, and other details.
Available in 8.0.1 or later
Input Parameters
| Field | Type | Required | Description |
|---|---|---|---|
vlanId | integer | optional | Filter by VLAN ID. Blank = all VLANs and untagged LAN. |
activeOnly | string | optional | yes or no. Blank = both. |
connectionType | array | optional | Filter: ethernet, wireless, pptp, stroute, l2tp, openvpn, pepvpn, other |
size | number | optional | Max clients returned (1–10000000). Default: 1000. |
outputWeight | string | optional | full, normal, lite |
infoType | array | optional | Specific fields: ip, connectionType, lease, name, mac, bssid, port, vlanId, essid, active, signalStrength, speed. Overrides outputWeight. |
Output Weight Comparison:
| Weight | Fields Included |
|---|---|
full | All details |
normal | ip, connectionType, clientType, name, mac, bssid, vlanId, essid, active |
lite | ip, connectionType, clientType, name, mac, bssid, vlanId |
Response
Returns a list array of Client objects:
| Field | Type | Description |
|---|---|---|
ip | string (IPv4) | IP address |
connectionType | string | ethernet, wireless, pptp, stroute, l2tp, openvpn, pepvpn, other. Absent if not active. |
lease | object | Lease info (ethernet/wireless only) |
name | string | Client name |
mac | string (MAC) | MAC address |
bssid | string (MAC) | BSSID (wireless only) |
vlanId | integer | VLAN ID (absent for untagged LAN) |
essid | string | SSID (wireless only) |
active | boolean | Active state |
signal | object | Signal strength and level (fw 8.1.0+) |
speed | object | Speed info: download, upload, unit |
Lease Object:
| Field | Type | Description |
|---|---|---|
expiresIn | integer | Lease expires in seconds |
type | string | normal, dhcp, wins |
Signal Object (fw 8.1.0+):
| Field | Type | Description |
|---|---|---|
strength | integer | Signal strength in dBm |
level | number | Signal level (1–5) |
cURL Example
curl -b cookies.txt \
"http://192.168.1.1/api/status.client?connectionType=ethernet&connectionType=wireless"
{
"stat": "ok",
"response": {
"list": [
{
"ip": "192.168.50.4",
"connectionType": "wireless",
"name": "Android client",
"mac": "9C:5C:F9:2B:85:99",
"bssid": "00:1A:DD:ED:8F:69",
"essid": "PEPWAVE_D3B1",
"active": true
},
{
"ip": "192.168.50.11",
"connectionType": "ethernet",
"name": "macOS client",
"mac": "E4:25:E7:8A:D3:12",
"active": false
}
]
}
}
GET /api/status.extap.mesh
Obtain the status of the mesh network.
Available in 8.3.2 or later
Response
| Field | Type | Description |
|---|---|---|
order | array | List of mesh profile IDs |
<mesh_profile_id> | object | Mesh profile status |
Mesh_Profile Object:
| Field | Type | Description |
|---|---|---|
meshId | string | Mesh ID |
peer | array | List of connected device objects |
Connected_Device Object:
| Field | Type | Description |
|---|---|---|
deviceInfo | object | Device info: id, serialNumber, name |
duration | integer | Connected duration in seconds |
rssi | number | RSSI (-192 to 63) |
signalLevel | number | Signal level (0–5) |
mac | string (MAC) | Peer MAC address |
peerName | string | Peer name (absent if none) |
linkType | string | Always mesh |
meshId | string | Mesh ID |
protocol | string | ng, na, ac, axg, axa |
rx | object | Receive: rate, packet, byte |
tx | object | Transmit: rate, packet, byte |
cURL Example
curl -b cookies.txt http://192.168.1.1/api/status.extap.mesh
{
"stat": "ok",
"response": {
"1": {
"meshId": "mesh A",
"peer": [
{
"deviceInfo": {
"id": 6917676,
"serialNumber": "AAAABBBBCCCC",
"name": "AP-One"
},
"duration": 22010,
"rssi": -36,
"signalLevel": 5,
"mac": "edab784eea89",
"linkType": "mesh",
"meshId": "mesh A",
"protocol": "ac",
"rx": { "rate": "2161.36M", "packet": 12416, "byte": 1458903 },
"tx": { "rate": "1921.5M", "packet": 30292, "byte": 6105135 }
}
]
},
"order": [1]
}
}
GET /api/status.extap.mesh.link
⚠️ Alpha API
Returns the link and node status of the mesh cluster.
Available in 8.4.2 or later
Response
| Field | Type | Description |
|---|---|---|
links | array | List of mesh link objects |
nodes | object | Mesh node objects |
Mesh_Link Object:
| Field | Type | Description |
|---|---|---|
linkType | string | 2.4GHz, 5GHz, ethernet, router |
from | object | Link endpoint: serialNumber, txRate, rxRate, signalLevel, rssi |
to | object | Link endpoint (same fields as from) |
Mesh_Node Object (keyed by serial number):
| Field | Type | Description |
|---|---|---|
name | string | Device name |
minimumHopCountToGateway | integer | Hops to gateway (-1 = router, 1 = first-hop/gateway) |
cURL Example
curl -b cookies.txt http://192.168.1.1/api/status.extap.mesh.link
GET /api/status.lan.profile
Obtain LAN status.
Available in 7.1.0 or later
Input Parameters
| Field | Type | Required | Description |
|---|---|---|---|
id | array | optional | List of LAN IDs. Returns all if absent. |
Response
| Field | Type | Description |
|---|---|---|
order | array | Order of LAN IDs |
<profile_id> | object | LAN status information |
LAN_Status Object:
| Field | Type | Description |
|---|---|---|
name | string | LAN / VLAN name |
vlanId | number | VLAN ID (1–4094). Absent if not VLAN. |
ip | string (IPv4) | IP address |
mask | number | Subnet mask |
cURL Example
curl -b cookies.txt http://192.168.1.1/api/status.lan.profile
{
"stat": "ok",
"response": {
"0": {
"ip": "10.6.1.231",
"mask": 16
},
"1": {
"name": "Name 1",
"ip": "10.6.1.231",
"vlanId": 164,
"mask": 16
},
"order": [0, 1]
}
}
GET /api/status.pepvpn
⚠️ Beta API
Obtain SpeedFusion VPN status.
Available in 7.1.0 or later
Input Parameters
| Field | Type | Required | Description |
|---|---|---|---|
infoType | array | optional | profile, peer, tunnel |
lite | string | optional | yes for limited data |
tunnelOption | array | optional | Peer IDs for tunnel info |
start | integer | optional | Start number of peer list |
size | integer | optional | Output size of peer list |
searchPattern | string | optional | Search peer by string |
serialNumber | string | optional | Search peer by serial number |
Response
Profile:
| Field | Type | Description |
|---|---|---|
order | array | Profile ID order |
<profile_id> | object | Profile info: name, master, vlanId, status, type, etc. |
siteId | string | Local ID of the device |
Profile Status Values: START, AUTHEN, TUNNEL, ROUTE, CONFLICT, CONNECTED
Peer Object:
| Field | Type | Description |
|---|---|---|
serialNumber | string | Peer device serial number |
status | string | Connection status |
name | string | Peer device name |
profileId | integer | Profile ID |
secure | boolean | Connection is secured |
type | string | l3, l2, nats, natc |
route | array | Routes (Layer 3 only) |
peerId | string | Unique peer ID |
Tunnel:
Contains WAN-level tunnel statistics including state, rtt, receive/transmit packet counters, and overall statistics.
Tunnel WAN States: INVALID, WAN_DOWN, WAN_DISABLED, DETECTING, FAILURE, REMOTE_FAILURE, COLD, STANDBY, P-SUSPD, D-SUSPD, U-SUSPD, P-ACTIV, D-ACTIV, U-ACTIV, ACTIVE
cURL Example
curl -b cookies.txt \
"http://192.168.1.1/api/status.pepvpn?infoType=profile&infoType=peer&lite=yes&tunnelOption=1-1"
{
"stat": "ok",
"response": {
"profile": {
"1": { "name": "Next (1)", "master": true },
"2": { "name": "Next (2 - 2)", "master": true },
"siteId": "999",
"order": [2, 1]
},
"peer": [
{
"serialNumber": "1825-4131-B4E7",
"status": "CONNECTED",
"name": "Ke-B580-x64-30",
"profileId": 1,
"secure": true,
"type": "l3",
"username": "dev30",
"route": ["192.168.30.0/24"],
"peerId": "1-1"
}
],
"tunnel": {
"1-1": {
"wan": {
"1": {
"time": { "second": 1292258, "nanoSecond": 485618662 },
"rtt": 1,
"priority": 1,
"state": "ACTIVE",
"name": "WAN 1"
},
"order": [1, 2, 3, 4, 5, 6]
},
"overall": {
"time": { "second": 1292258, "nanoSecond": 485618662 },
"receive": { "packet": { "forward": 32, "loss": 1, "outOfOrder": 0 } },
"transmit": { "packet": { "forward": 12, "loss": 0, "outOfOrder": 0 } }
}
},
"order": ["1-1"]
}
}
}
GET /api/status.wan.connection
Obtain the WAN status.
Available in 8.0.0 or later
Input Parameters
| Field | Type | Required | Description |
|---|---|---|---|
id | array | optional | WAN IDs. Returns all if absent. |
lite | string | optional | yes for limited data. No effect on MAX devices. |
Response
| Field | Type | Description |
|---|---|---|
order | array | Order of connection IDs |
<conn_id> | object | WAN status object |
WAN_Status Object:
| Field | Type | Description |
|---|---|---|
name | string | Connection name |
statusLed | string | empty, gray, red, yellow, green, flash |
asLan | boolean | WAN as LAN mode |
enable | boolean | WAN enabled |
locked | boolean | WAN locked |
scheduledOff | boolean | Currently off by schedule |
message | string | Status message |
uptime | integer | Uptime in seconds |
type | string | modem, wireless, gobi, cellular, ipsec, adsl, ethernet |
priority | integer | Priority (absent if disabled) |
ip | string (IPv4) | IP address |
mask | number | Subnet mask |
gateway | string (IPv4) | Gateway |
method | string | dhcp or static |
routingMode | string | NAT or IP Forwarding (fw 8.0.1+) |
dns | array | DNS servers |
mtu | number | MTU value |
mac | string (MAC) | MAC address |
wireless | object | Wi-Fi details (wireless only) |
cellular | object | Cellular details (cellular only) |
bandwidthAllowanceMonitor | object | Bandwidth monitor info |
Cellular (Gobi) Object:
| Field | Type | Description |
|---|---|---|
roamingStatus | object | Roaming code and message |
mobileType | string | Network type (fw 8.0.1+) |
sim | object | SIM information |
remoteSim | object | RemoteSIM info (if enabled) |
carrier | object | Carrier name and country |
carrierAggregation | boolean | Carrier aggregation |
signalLevel | number | Signal level (0–5) |
imei | string | IMEI |
band | array | Band info (deprecated in fw 8.1.2, use rat) |
rat | array | Radio Access Technology (fw 8.1.2+) |
mcc | string | Mobile Country Code |
mnc | string | Mobile Network Code |
cellTower | object | Cell tower info |
Signal Object:
| Field | Type | Description |
|---|---|---|
rssi | integer | Received Signal Strength Indicator |
sinr | number | Signal to Interference plus Noise Ratio |
rsrp | integer | Reference Signal Received Power |
rsrq | number | Reference Signal Received Quality |
Roaming Status:
| Code | Message |
|---|---|
0 | roaming |
1 | home |
2 | roaming partner |
cURL Example
curl -b cookies.txt \
"http://192.168.1.1/api/status.wan.connection?id=1&id=2"
{
"stat": "ok",
"response": {
"1": {
"name": "CUST WAN 1",
"enable": true,
"asLan": false,
"message": "Connected",
"uptime": 27037017,
"type": "ethernet",
"virtualType": "ethernet",
"priority": 0,
"ip": "192.168.123.144",
"statusLed": "green",
"mask": 24,
"gateway": "12.23.34.0",
"method": "dhcp",
"mode": "NAT",
"dns": ["12.22.32.12", "12.34.67.89"],
"mtu": 576
},
"2": {
"name": "WAN2",
"enable": true,
"asLan": false,
"message": "No Cable Detected",
"uptime": 27066417,
"type": "ethernet",
"virtualType": "ethernet",
"priority": 0,
"statusLed": "red",
"method": "static",
"mode": "IP Forwarding",
"mtu": 1440
},
"order": [1, 2]
}
}
GET /api/status.wan.connection.allowance
Obtain the bandwidth allowance of the WAN connection or SIM.
Available in 8.0.0 or later
Input Parameters
| Field | Type | Required | Description |
|---|---|---|---|
connId | array | optional | Connection IDs. In fw 8.0.0, mandatory and cellular only. In fw 8.0.1+, optional and supports all WAN types. |
Response
For cellular WANs, response is keyed by conn_id, then sim_id:
Allowance Object:
| Field | Type | Description |
|---|---|---|
enable | boolean | Enabled |
usage | integer | Data used in MB |
limit | integer | Monthly allowance in MB |
percent | number | Usage percentage (0–100) |
start | number | Start day (0–28, 0 = last day of month) |
unit | string | MB |
cURL Example
curl -b cookies.txt \
"http://192.168.1.1/api/status.wan.connection.allowance?connId=1"
{
"stat": "ok",
"response": {
"1": {
"1": {
"enable": true,
"usage": 5,
"limit": 1024,
"percent": 0,
"start": 1,
"unit": "MB"
}
},
"order": [1]
}
}