RustMinerSystem

Документация

API dashboard, версий и системных настроек

Endpoints RustMinerSystem для валют, ресурсов, версий, RMS, уведомлений, preset pools и KENC.

API dashboard, версий и системных настроек

Эти endpoints обслуживают dashboard, сведения о версии и основные системные настройки. Внешний API не требует входа и передает custom authentication header непосредственно в каждом запросе.

Валюты и системная информация

Метод Путь Назначение/параметры
GET /api/currency/config Валюты, алгоритмы, icons и public visibility.
GET /api/sys/base/info ОС, CPU, память и диски.
GET /api/sys/stat История CPU, памяти и сетевого трафика.
GET /api/device/stats История общего количества устройств.
GET /api/currency/online/stat/{coin} История online-устройств одной монеты.
GET /api/stat/currency/{currency} История хешрейта валюты.
POST /api/config/refresh Обновить algorithm engine; не вызывайте часто.

В {coin} и {currency} используются backend-коды, например BTC, KAS или код PoolNode.

Версия и состояние процесса

Метод Путь Назначение
GET /api/local/version Текущая версия.
GET /api/version Remote version и конфигурация App Center.
GET /api/releases История релизов.
GET /api/sys/starttime Timestamp запуска.
GET /api/mb/port Порт и состояние mobile access.
GET /api/u/i UUID экземпляра.
POST /api/failed/reset Сбросить флаг crash/startup failure.

В разных версиях данные версии могут быть строкой или объектом с version; клиенту следует поддерживать оба формата.

Уведомления об offline

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

Frontend использует, среди прочего:

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

Backend может вернуть дополнительные поля, например порог падения хешрейта. Перед сохранением прочитайте объект и объедините изменения, чтобы не потерять новые настройки.

Конфигурация RMS

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

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

Если GET сообщает, что конфигурация не зарегистрирована, frontend создает ее с mode: 0, pool_mode: 0 и стандартным title. При сохранении он добавляет текущий host; protocol=1 означает HTTPS, 0 — HTTP. ports и peers являются объектами с портами в качестве ключей; вложенную структуру берите из текущего ответа.

Preset pools и wallets

Метод Путь Назначение
GET /api/local/pool/endpoint Получить preset pools, wallets и custom entries.
POST /api/local/pool/endpoint Сохранить полный объект настроек.
GET /api/pool/info/{id} Получить встроенные варианты pools; frontend использует id=1.

POST заменяет полный объект. Для автоматизации сначала выполните GET и merge, чтобы сохранить customPool и customWallet.

Ключ KENC

Метод Путь Назначение
GET /api/kc/key Получить custom KENC key.
POST /api/kc/key Сохранить custom KENC key.
POST /api/kc/reset Восстановить стандартный KENC key. 
{
  "k": "<custom key>"
}

Смена ключа может повлиять на подключенные clients. Сначала проверьте совпадение настроек клиента и сервера.