Sign in

v51

latestOpenAPI 3.1.0GNU General Public License version 3raw.githubusercontent.com2026-08-01151240.0 KB
system

Update system settings

Updates system configuration settings

patch/api/system

Request body

useFallbackStratumnumber

Forces the use the fallback stratum pool

primaryPoolIndexinteger

Index of the primary pool

secondaryPoolIndexinteger

Index of the secondary pool (fallback)

stratumURLstring

Primary stratum server URL

fallbackStratumURLstring

Fallback stratum server URL used when primary is unavailable

stratumUserstring

Username for primary stratum server

stratumPasswordstring

Password for primary stratum server

fallbackStratumUserstring

Username for fallback stratum server

fallbackStratumPasswordstring

Password for fallback stratum server

stratumPortinteger

Port number for primary stratum server

stratumProtocol'SV1' | 'SV2'

Stratum protocol

stratumV2ChannelType'standard' | 'extended'

SV2 channel type

stratumV2AuthorityPubkeystring

Optional SV2 authority public key for certificate verification (base58-encoded)

fallbackStratumPortinteger

Port number for fallback stratum server

fallbackStratumProtocol'SV1' | 'SV2'

Fallback stratum protocol

fallbackStratumV2ChannelType'standard' | 'extended'

Fallback SV2 channel type

fallbackStratumV2AuthorityPubkeystring

Optional fallback SV2 authority public key for certificate verification (base58-encoded)

ssidstring

WiFi network SSID

wifiPassstring

WiFi network password

hostnamestring

Device hostname

coreVoltageinteger

ASIC core voltage in millivolts

frequencyinteger

ASIC frequency in MHz

rotation0 | 1

Whether to rotate the screen orientation (0, 90, 180, 270 degrees)

overheat_mode0

Overheat protection mode (0=disabled)

overclockEnabled0 | 1

Set custom voltage/frequency in AxeOS (0=disabled, 1=enabled)

useCustomWWW0 | 1

Whether to serve files from the SPIFFS www partition instead of the embedded Web UI (0=embedded, 1=custom/SPIFFS)

invertscreen0 | 1

Whether to invert screen colors (0=normal, 1=inverted)

autofanspeed0 | 1

Whether to enable automatic fan speed control (0=manual, 1=auto)

fanspeedinteger

Manual fan speed percentage when autofanspeed is disabled

temptargetinteger

Manual Temperature Target in °C when autofanspeed is enabled

displayTimeoutinteger

Set display timeout time in minutes (-1=display on, 0=display off)

statsFrequencyinteger

Set statistics frequency in seconds (0=disabled)

Example request

{
  "stratumURL": "stratum+tcp://pool.example.com",
  "fallbackStratumURL": "stratum+tcp://backup.example.com",
  "stratumUser": "worker1",
  "stratumPassword": "x",
  "fallbackStratumUser": "worker1",
  "fallbackStratumPassword": "x",
  "stratumPort": 3333,
  "stratumProtocol": "SV1",
  "stratumV2ChannelType": "standard",
  "fallbackStratumPort": 3333,
  "fallbackStratumProtocol": "SV1",
  "fallbackStratumV2ChannelType": "standard",
  "ssid": "MyWiFiNetwork",
  "wifiPass": "MySecurePassword123",
  "hostname": "esp-miner-1",
  "coreVoltage": 850,
  "frequency": 450,
  "autofanspeed": 1,
  "fanspeed": 80,
  "temptarget": 66,
  "displayTimeout": 10,
  "statsFrequency": 120
}

Response

Settings updated successfully

statusstring

Example response

{
  "status": "success"
}