---
title: "Update system settings"
method: PATCH
path: "/api/system"
tags: ["system"]
---

# Update system settings

`PATCH /api/system`

Updates system configuration settings

## Request body

- Settings
  - `useFallbackStratum` number — Forces the use the fallback stratum pool
  - `primaryPoolIndex` integer — Index of the primary pool
  - `secondaryPoolIndex` integer — Index of the secondary pool (fallback)
  - `pools` Pool[] — Configured stratum pools
    - `stratumProtocol` 'SV1' | 'SV2' — Stratum protocol
    - `stratumURL` string, required — Stratum server URL
    - `stratumPort` integer, required — Stratum server port
    - `stratumUser` string, required — Stratum username
    - `stratumPassword` string — Stratum password
    - `stratumSuggestedDifficulty` number — Suggested difficulty
    - `stratumExtranonceSubscribe` boolean — Enable extranonce subscribe
    - `stratumTLS` integer — Enable stratum TLS (0=disabled, 1=enabled, 2=enabled with verification)
    - `stratumCert` string — Stratum TLS cert
    - `stratumDecodeCoinbase` boolean — Enable pool coinbase transaction decoding
    - `stratumV2ChannelType` 'standard' | 'extended' — SV2 channel type
    - `stratumV2AuthorityPubkey` string — SV2 authority public key for certificate verification (base58-encoded)
    - `stratumV2RequireAuth` boolean — Refuse to connect unless the SV2 server certificate is verified against the authority pubkey
    - `id` integer — Pool NVS slot index (0 to 7)
  - `stratumURL` string — Primary stratum server URL
  - `fallbackStratumURL` string — Fallback stratum server URL used when primary is unavailable
  - `stratumUser` string — Username for primary stratum server
  - `stratumPassword` string — Password for primary stratum server
  - `fallbackStratumUser` string — Username for fallback stratum server
  - `fallbackStratumPassword` string — Password for fallback stratum server
  - `stratumPort` integer — Port number for primary stratum server
  - `stratumProtocol` 'SV1' | 'SV2' — Stratum protocol
  - `stratumV2ChannelType` 'standard' | 'extended' — SV2 channel type
  - `stratumV2AuthorityPubkey` string — Optional SV2 authority public key for certificate verification (base58-encoded)
  - `fallbackStratumPort` integer — Port number for fallback stratum server
  - `fallbackStratumProtocol` 'SV1' | 'SV2' — Fallback stratum protocol
  - `fallbackStratumV2ChannelType` 'standard' | 'extended' — Fallback SV2 channel type
  - `fallbackStratumV2AuthorityPubkey` string — Optional fallback SV2 authority public key for certificate verification (base58-encoded)
  - `ssid` string — WiFi network SSID
  - `wifiPass` string — WiFi network password
  - `hostname` string — Device hostname
  - `coreVoltage` integer — ASIC core voltage in millivolts
  - `frequency` integer — ASIC frequency in MHz
  - `rotation` 0 | 1 — Whether to rotate the screen orientation (0, 90, 180, 270 degrees)
  - `overheat_mode` 0 — Overheat protection mode (0=disabled)
  - `overclockEnabled` 0 | 1 — Set custom voltage/frequency in AxeOS (0=disabled, 1=enabled)
  - `useCustomWWW` 0 | 1 — Whether to serve files from the SPIFFS www partition instead of the embedded Web UI (0=embedded, 1=custom/SPIFFS)
  - `invertscreen` 0 | 1 — Whether to invert screen colors (0=normal, 1=inverted)
  - `autofanspeed` 0 | 1 — Whether to enable automatic fan speed control (0=manual, 1=auto)
  - `fanspeed` integer — Manual fan speed percentage when autofanspeed is disabled
  - `temptarget` integer — Manual Temperature Target in °C when autofanspeed is enabled
  - `displayTimeout` integer — Set display timeout time in minutes (-1=display on, 0=display off)
  - `statsFrequency` integer — Set statistics frequency in seconds (0=disabled)

## Response `200`

Settings updated successfully

- UpdateSettingsResponse
  - `status` string
  - `redirect` object
    - `url` string
    - `delay` number
    - `message` string

## Other responses

- `400` — Invalid settings provided
- `401` — Unauthorized - Client not in allowed network range
- `500` — Internal server error

---

[API](https://skmtc.net/bitaxeorg/apis/esp-miner-api.md) · [All operations](https://skmtc.net/bitaxeorg/apis/esp-miner-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bitaxeorg/esp-miner-api/versions/b690144f0d13/schema)