Skip to main content

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

FieldTypeRequiredDescription
connIdnumberWAN connection ID of the cellular module

Response

FieldTypeDescription
temperatureintegerTemperature 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

FieldTypeRequiredDescription
vlanIdintegeroptionalFilter by VLAN ID. Blank = all VLANs and untagged LAN.
activeOnlystringoptionalyes or no. Blank = both.
connectionTypearrayoptionalFilter: ethernet, wireless, pptp, stroute, l2tp, openvpn, pepvpn, other
sizenumberoptionalMax clients returned (1–10000000). Default: 1000.
outputWeightstringoptionalfull, normal, lite
infoTypearrayoptionalSpecific fields: ip, connectionType, lease, name, mac, bssid, port, vlanId, essid, active, signalStrength, speed. Overrides outputWeight.

Output Weight Comparison:

WeightFields Included
fullAll details
normalip, connectionType, clientType, name, mac, bssid, vlanId, essid, active
liteip, connectionType, clientType, name, mac, bssid, vlanId

Response

Returns a list array of Client objects:

FieldTypeDescription
ipstring (IPv4)IP address
connectionTypestringethernet, wireless, pptp, stroute, l2tp, openvpn, pepvpn, other. Absent if not active.
leaseobjectLease info (ethernet/wireless only)
namestringClient name
macstring (MAC)MAC address
bssidstring (MAC)BSSID (wireless only)
vlanIdintegerVLAN ID (absent for untagged LAN)
essidstringSSID (wireless only)
activebooleanActive state
signalobjectSignal strength and level (fw 8.1.0+)
speedobjectSpeed info: download, upload, unit

Lease Object:

FieldTypeDescription
expiresInintegerLease expires in seconds
typestringnormal, dhcp, wins

Signal Object (fw 8.1.0+):

FieldTypeDescription
strengthintegerSignal strength in dBm
levelnumberSignal 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

FieldTypeDescription
orderarrayList of mesh profile IDs
<mesh_profile_id>objectMesh profile status

Mesh_Profile Object:

FieldTypeDescription
meshIdstringMesh ID
peerarrayList of connected device objects

Connected_Device Object:

FieldTypeDescription
deviceInfoobjectDevice info: id, serialNumber, name
durationintegerConnected duration in seconds
rssinumberRSSI (-192 to 63)
signalLevelnumberSignal level (0–5)
macstring (MAC)Peer MAC address
peerNamestringPeer name (absent if none)
linkTypestringAlways mesh
meshIdstringMesh ID
protocolstringng, na, ac, axg, axa
rxobjectReceive: rate, packet, byte
txobjectTransmit: 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]
}
}

⚠️ Alpha API

Returns the link and node status of the mesh cluster.

Available in 8.4.2 or later

Response

FieldTypeDescription
linksarrayList of mesh link objects
nodesobjectMesh node objects

Mesh_Link Object:

FieldTypeDescription
linkTypestring2.4GHz, 5GHz, ethernet, router
fromobjectLink endpoint: serialNumber, txRate, rxRate, signalLevel, rssi
toobjectLink endpoint (same fields as from)

Mesh_Node Object (keyed by serial number):

FieldTypeDescription
namestringDevice name
minimumHopCountToGatewayintegerHops 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

FieldTypeRequiredDescription
idarrayoptionalList of LAN IDs. Returns all if absent.

Response

FieldTypeDescription
orderarrayOrder of LAN IDs
<profile_id>objectLAN status information

LAN_Status Object:

FieldTypeDescription
namestringLAN / VLAN name
vlanIdnumberVLAN ID (1–4094). Absent if not VLAN.
ipstring (IPv4)IP address
masknumberSubnet 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

FieldTypeRequiredDescription
infoTypearrayoptionalprofile, peer, tunnel
litestringoptionalyes for limited data
tunnelOptionarrayoptionalPeer IDs for tunnel info
startintegeroptionalStart number of peer list
sizeintegeroptionalOutput size of peer list
searchPatternstringoptionalSearch peer by string
serialNumberstringoptionalSearch peer by serial number

Response

Profile:

FieldTypeDescription
orderarrayProfile ID order
<profile_id>objectProfile info: name, master, vlanId, status, type, etc.
siteIdstringLocal ID of the device

Profile Status Values: START, AUTHEN, TUNNEL, ROUTE, CONFLICT, CONNECTED

Peer Object:

FieldTypeDescription
serialNumberstringPeer device serial number
statusstringConnection status
namestringPeer device name
profileIdintegerProfile ID
securebooleanConnection is secured
typestringl3, l2, nats, natc
routearrayRoutes (Layer 3 only)
peerIdstringUnique 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

FieldTypeRequiredDescription
idarrayoptionalWAN IDs. Returns all if absent.
litestringoptionalyes for limited data. No effect on MAX devices.

Response

FieldTypeDescription
orderarrayOrder of connection IDs
<conn_id>objectWAN status object

WAN_Status Object:

FieldTypeDescription
namestringConnection name
statusLedstringempty, gray, red, yellow, green, flash
asLanbooleanWAN as LAN mode
enablebooleanWAN enabled
lockedbooleanWAN locked
scheduledOffbooleanCurrently off by schedule
messagestringStatus message
uptimeintegerUptime in seconds
typestringmodem, wireless, gobi, cellular, ipsec, adsl, ethernet
priorityintegerPriority (absent if disabled)
ipstring (IPv4)IP address
masknumberSubnet mask
gatewaystring (IPv4)Gateway
methodstringdhcp or static
routingModestringNAT or IP Forwarding (fw 8.0.1+)
dnsarrayDNS servers
mtunumberMTU value
macstring (MAC)MAC address
wirelessobjectWi-Fi details (wireless only)
cellularobjectCellular details (cellular only)
bandwidthAllowanceMonitorobjectBandwidth monitor info

Cellular (Gobi) Object:

FieldTypeDescription
roamingStatusobjectRoaming code and message
mobileTypestringNetwork type (fw 8.0.1+)
simobjectSIM information
remoteSimobjectRemoteSIM info (if enabled)
carrierobjectCarrier name and country
carrierAggregationbooleanCarrier aggregation
signalLevelnumberSignal level (0–5)
imeistringIMEI
bandarrayBand info (deprecated in fw 8.1.2, use rat)
ratarrayRadio Access Technology (fw 8.1.2+)
mccstringMobile Country Code
mncstringMobile Network Code
cellTowerobjectCell tower info

Signal Object:

FieldTypeDescription
rssiintegerReceived Signal Strength Indicator
sinrnumberSignal to Interference plus Noise Ratio
rsrpintegerReference Signal Received Power
rsrqnumberReference Signal Received Quality

Roaming Status:

CodeMessage
0roaming
1home
2roaming 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

FieldTypeRequiredDescription
connIdarrayoptionalConnection 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:

FieldTypeDescription
enablebooleanEnabled
usageintegerData used in MB
limitintegerMonthly allowance in MB
percentnumberUsage percentage (0–100)
startnumberStart day (0–28, 0 = last day of month)
unitstringMB

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]
}
}