System

Read-only system information and runtime statistics

Get build and hardware information

get

Returns ESP-IDF version, firmware build/version numbers, chip model, MAC address, license status, activation key, and whether serial is tunnelled over JTAG.

Responses

200

System info retrieved successfully

application/json

Static build and hardware information

idf_versionstringOptional

ESP-IDF version string

Example: v5.2.1

db_build_versionnumberOptional

Monotonic build number

Example: 42

major_versionnumberOptionalExample: 1

minor_versionnumberOptionalExample: 5

patch_versionnumberOptionalExample: 0

maturity_versionstringOptional

Release maturity label (e.g. "release", "beta", "rc1")

Example: release

license_typestringOptional

Human-readable license type

Example: ACTIVATED

expiration_datestringOptional

License expiration date as a formatted string, or "Never" for perpetual licenses, or a remaining-time string for trial licenses.

Example: 2026-12-31

activation_keystringOptional

Base64-encoded activation key for this device

Example: ABCD1234EFGH

esp_chip_modelnumber · enumOptional

Numeric chip id, 5=ESP32C3, 13=ESP32C6, 23=ESP32C5

Possible values:

has_rf_switchnumber · enumOptional

1 if an RF switch is present on the board, 0 otherwise

Possible values:

esp_macstringOptional

Primary MAC address of the ESP32 (colon-separated hex)

Example: AA:BB:CC:DD:EE:FF

serial_via_JTAGnumber · enumOptional

1 if serial is tunnelled over JTAG, 0 otherwise

Possible values:

get

/api/system/info

HTTPcURLJavaScriptPython

GET /api/system/info HTTP/1.1
Host: 192.168.2.1
Accept: */*

200

System info retrieved successfully

{
  "idf_version": "v5.2.1",
  "db_build_version": 42,
  "major_version": 1,
  "minor_version": 5,
  "patch_version": 0,
  "maturity_version": "release",
  "license_type": "ACTIVATED",
  "expiration_date": "2026-12-31",
  "activation_key": "ABCD1234EFGH",
  "esp_chip_model": 5,
  "has_rf_switch": 0,
  "esp_mac": "AA:BB:CC:DD:EE:FF",
  "serial_via_JTAG": 0
}

Get runtime statistics

get

Returns serial byte counters, TCP/UDP connection counts, connected station details (AP mode) or RSSI/IP (STA mode), flight-controller power and armed state, battery voltage and current, and CPU load.

Responses

200

Runtime stats retrieved successfully

application/json

Runtime counters and connection status

read_bytesnumberOptional

Total bytes read from the UART since last boot

Example: 102400

tcp_connectednumberOptional

Number of currently connected TCP clients

Example: 1

udp_connectednumberOptional

Number of UDP destinations in the active client list

Example: 2

udp_clientsstring[]Optional

List of active UDP destinations as "IP:port" strings

Example: 192.168.2.255:14550

current_client_ipstringOptional

IP address of the ESP32 in STA mode (only present when radio_mode == DB_WIFI_MODE_STA)

Example: 192.168.1.42

esp_rssinumberOptional

RSSI of the upstream AP in STA mode (only present when radio_mode == DB_WIFI_MODE_STA)

Example: -65

fc_pw_statenumberOptional

Flight-controller power state. 1 = powered, 0 = unpowered, -1 = power management disabled.

Example: 1

fc_armed_statenumberOptional

UAV armed state as reported by the power-management module. 0 = disarmed, 1 = armed.

Example: 0

battery_voltagenumberOptional

Battery voltage in volts (ADC measurement)

Example: 12.4

battery_currentnumberOptional

Battery current in amperes (ADC measurement)

Example: 3.2

cpu_loadnumberOptional

CPU utilisation percentage multiplied by 100 (0–100)

Example: 5018

get

/api/system/stats

HTTPcURLJavaScriptPython

GET /api/system/stats HTTP/1.1
Host: 192.168.2.1
Accept: */*

200

Runtime stats retrieved successfully

{
  "read_bytes": 102400,
  "tcp_connected": 1,
  "udp_connected": 2,
  "udp_clients": [
    "192.168.2.255:14550"
  ],
  "current_client_ip": "192.168.1.42",
  "esp_rssi": -65,
  "connected_sta": [
    {
      "sta_mac": "11:22:33:44:55:66",
      "sta_rssi": -58
    }
  ],
  "fc_pw_state": 1,
  "fc_armed_state": 0,
  "battery_voltage": 12.4,
  "battery_current": 3.2,
  "cpu_load": 5018
}

List active UDP client connections

get

Returns the list of UDP IP:port pairs the ESP32 is currently forwarding data to.

Responses

200

Client list retrieved successfully

application/json

Active UDP forwarding destinations

udp_clientsstring[]Optional

List of "IP:port" strings

Example: 192.168.2.255:14550

get

/api/system/clients

HTTPcURLJavaScriptPython

GET /api/system/clients HTTP/1.1
Host: 192.168.2.1
Accept: */*

200

Client list retrieved successfully

{
  "udp_clients": [
    "192.168.2.255:14550"
  ]
}