RustMinerSystem

Documentation

Dashboard, Version, and System Configuration API

RustMinerSystem currency, resource, version, RMS, notification, preset-pool, and KENC configuration endpoints.

Dashboard, Version, and System Configuration API

These endpoints supply the dashboard, program-version panels, and common system settings. External API calls require no login and send the custom API authentication header directly.

Currency and system information

Method Path Purpose/parameters
GET /api/currency/config Read currency, algorithm, icon, and public-visibility metadata.
GET /api/sys/base/info Read OS, CPU, memory, and disk information.
GET /api/sys/stat Read CPU, memory, and network-traffic history.
GET /api/device/stats Read total device-count history.
GET /api/currency/online/stat/{coin} Read online-device history for one coin.
GET /api/stat/currency/{currency} Read hashrate history for one currency.
POST /api/config/refresh Request an algorithm-engine refresh; do not call frequently.

Use backend currency codes such as BTC, KAS, or a PoolNode-specific code in {coin} and {currency}.

Version and runtime state

Method Path Purpose
GET /api/local/version Read the running version.
GET /api/version Read remote version and App Center configuration.
GET /api/releases Read release notes.
GET /api/sys/starttime Read the program start timestamp.
GET /api/mb/port Read mobile-access port and state.
GET /api/u/i Read this instance’s UUID.
POST /api/failed/reset Clear the crash/startup-failure flag.

Depending on backend version, version data can be a string or an object with a version property. Clients should support both.

Offline notification settings

GET /api/warning/setting
POST /api/warning/setting

Fields used by the new frontend include:

{
  "is_off": 0,
  "wr": 0,
  "key": "<ServerChan key>",
  "smtp_email": "[email protected]",
  "smtp_secret": "<SMTP password or app secret>",
  "smtp_endpoint": "smtp.example.com",
  "smtp_port": 465,
  "smtp_use_tls": 1
}

Backend versions may return additional fields such as hashrate-loss thresholds. Read the current object and merge changes before saving so newer settings are preserved.

RMS client configuration

GET /api/rms/config
POST /api/rms/config

Example save request:

{
  "ports": {},
  "code": "",
  "mode": 0,
  "title": "RMS",
  "pool_mode": 0,
  "notice": "",
  "info": "",
  "peers": {},
  "host": "miner.example.com",
  "protocol": 1
}

When GET reports an unregistered configuration, the frontend registers defaults with mode: 0, pool_mode: 0, and the configured title. On save it also adds the current page host and uses protocol=1 for HTTPS or 0 for HTTP. Both ports and peers are objects keyed by port; treat the current response as the source of truth for their nested fields.

Preset pools and wallets

Method Path Purpose
GET /api/local/pool/endpoint Read preset pools, wallets, and custom entries.
POST /api/local/pool/endpoint Save the complete preset object.
GET /api/pool/info/{id} Read bundled pool options; the frontend currently uses id=1.

POST replaces the complete configuration. Read, merge, and save when automating changes so existing customPool and customWallet entries are not lost.

KENC key

Method Path Purpose
GET /api/kc/key Read the custom KENC key.
POST /api/kc/key Save the custom KENC key.
POST /api/kc/reset Restore the default KENC key.

Save request:

{
  "k": "<custom key>"
}

Changing the key can affect existing client connections. Confirm matching client and server configuration first.