Справочник по эндпоинтам
Активация гарантии майнера. Требует авторизации. Возвращает статус гарантии.
Ответ 200: WarrantyStatus Ответ 200 (OK): массив ApiKeysJsonItem
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| success | boolean | Да | Признак успешности операции |
| warranty | string (enum) | Нет | Статус гарантии. Значения: active — активна; inactive — неактивна; expired — истекла; cancelled — отменена; not_provided — не предоставлена |
Получение списка API-ключей. Требует авторизации. Возвращает массив ключей.
Ответ 200 (OK): массив ApiKeysJsonItem
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| key | string | Да | API-ключ длиной ровно 32 символа |
| description | string | Да | Описание ключа |
Добавление нового API-ключа. Требует авторизации. В теле запроса передаётся ключ и описание (AddApikeyQuery = ApiKeysJsonItem).
Ответ 200 (OK): AddApiKeyRes
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| status | string (enum) | Да | Результат операции. Значения: inserted — ключ добавлен; updated — ключ обновлён; nochanges — изменений нет |
Удаление API-ключа. Требует авторизации. В теле запроса передаётся ключ (DeleteApikeyQuery).
Ответ 200 (OK): тело отсутствует (Key deleted successfully).
Проверка авторизации. Возвращает информацию о таймауте до окончания временной блокировки устройства.
Ответ 200 (OK): AuthCheck
Если устройство не находится во временной блокировке возвращается пустой объект:
{}
Если устройство находится во временной блокировке, в ответе присутствует поле unlock_timeout, содержащее количество секунд, оставшихся до окончания блокировки:
{
"unlock_timeout":58
}
Примечание: отсутствие поля
unlock_timeoutэквивалентно значениюnullи означает, что временная блокировка отсутствует.
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| unlock_timeout | integer (int64) | null | Нет | Таймаут блокировки (сек), неотрицательное значение |
Получение списка пресетов автотюна. Требует авторизации. Возвращает массив пресетов с настройками тюнинга.
Ответ 200 (OK): массив AutotunePresetDto
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| name | string | Да | Идентификатор (id) пресета |
| pretty | string | Да | Человекочитаемое имя пресета |
| status | string (enum) | Да | Статус пресета. Значения: untuned — не настроен; tuned — успешно настроен |
| tune_settings | object (AutotuneResultsItem) | null | Нет | Результаты тюнинга (см. ниже) |
Вложенный объект tune_settings ( AutotuneResultsItem ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| hashrate | integer (int32) | Да | Хешрейт, неотрицательный |
| volt | integer (int32) | Да | Напряжение, неотрицательное |
| freq | integer (int32) | Да | Частота, неотрицательная |
| chains | array (AutotuneBoard) | Да | Список плат: freq (int32), chips (массив int32), serial (string | null) |
| modified | boolean | Да | Признак ручного изменения |
| date | string | null | Нет | Дата тюнинга |
Сброс указанного списка профилей автотюна. Требует авторизации.
Ответ 200 (OK): тело отсутствует.
Тело запроса: AutotuneReset
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| presets | array of string | Да | Список пресетов для сброса |
| restart | boolean | Да | Перезапуск после удаления пресетов |
Сброс всех профилей автотюна. Требует авторизации.
Ответ 200 (OK): тело отсутствует.
Тело запроса: AutotuneResetAll
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| restart | boolean | Да | Перезапуск после сброса |
Получение плат майнера с детализацией по чипам и датчикам. Авторизация не требуется.
Ответ 200 (OK): массив AntmBoardChips
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| id | integer | Да | Идентификатор платы, неотрицательный |
| status | object (CgBoardStatus) | Да | Статус платы: state (enum), failure_message (string | null) |
| hr_realtime | number (float) | Да | Хешрейт в реальном времени |
| hr_nominal | number (float) | Да | Номинальный хешрейт |
| freq | number (float) | Да | Частота |
| sensors | array (AntmChipSensor) | Да | Датчики: state, board, chip, loc |
| chips | array (AntmChip) | Да | Чипы (см. ниже) |
Вложенный объект status ( CgBoardStatus ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| state | string (enum) | Да | Состояние платы. Значения: initializing, mining, stopped, failure, disconnected, disabled, unknown |
| failure_message | string | null | Нет | Текстовое описание ошибки (обычно заполняется при failure) |
Вложенный объект sensors[] ( AntmChipSensor ) — по одному элементу массива на каждый датчик:
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| state | string (enum) | Да | Статус датчика. Значения: init, ready, measure, error, unknown |
| board | integer (int32) | Да | Номер платы, к которой относится датчик |
| chip | integer (int32) | Да | Номер чипа, к которому относится датчик |
| loc | integer (int32) | Да | Расположение датчика — ссылается на chip.id, неотрицательное |
Вложенный объект чипа AntmChip :
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| id | integer | Да | Идентификатор чипа |
| hr | number (float) | Да | Хешрейт |
| freq | integer (int32) | Да | Частота |
| volt | integer (int32) | Да | Напряжение |
| temp | number (float) | Да | Температура |
| errs | integer (int32) | Да | Количество ошибок |
| grade | string (enum) | Да | Оценка чипа. Значения: grey, orange, red |
| throttled | boolean | Да | Признак троттлинга |
Отмена гарантии майнера. Требует авторизации.
Ответ 200 (OK): WarrantyStatus
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| success | boolean | Да | Признак успешности операции |
| warranty | string (enum) | Нет | Статус гарантии. Значения: active, inactive, expired, cancelled, not_provided |
Получение заводской информации о платах майнера. Авторизация не требуется.
Ответ 200 (OK): FactoryInfoReply
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| chains | array (FactoryInfoBoard) | null | Нет | Список плат с заводскими данными |
| has_pics | boolean | null | Нет | Наличие PIC-контроллеров |
| hr_stock | number (double) | null | Нет | Стоковый хешрейт |
| psu_model | string | null | Нет | Модель блока питания |
| psu_serial | string | null | Нет | Серийный номер блока питания |
Вложенный объект: FactoryInfoBoard
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| id | integer (int32) | Да | Идентификатор платы |
| board_model | string | Да | Модель платы |
| serial | string | Да | Серийный номер |
| chip_bin | integer (int32) | Да | Бин чипов |
| freq | integer (int32) | Да | Частота |
| volt | integer (int32) | Да | Напряжение |
| hashrate | number (double) | Да | Хешрейт |
Удаление прошивки и загрузка со стоковой. Требует авторизации. После операции система перезагрузится.
Ответ 200 (OK): RebootAfter
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| after | integer (int64) | Да | Через сколько секунд система перезагрузится (по умолчанию 3), неотрицательное |
Тело запроса: FwRemoveParams
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| remove_stock_logs | boolean | Да | Удалять ли стоковые логи |
Обновление прошивки. Требует авторизации. После обновления система перезагрузится.
Ответ 200: RebootAfter
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| after | integer (int64) | Да | Через сколько секунд система перезагрузится (по умолчанию 3) |
Тело запроса: SchemaFirmwareUpdate (multipart/form-data)
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| file | string (binary) | Да | Файл прошивки |
| keep_settings | string (enum) | null | Нет | Сохранять настройки. Значения: true, false |
Получение общей информации о майнере (данные прошивки + модель, алгоритм, система). Авторизация не требуется.
Ответ 200 (OK): InfoJson
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| fw_name | string | Да | Имя прошивки |
| fw_version | string | Да | Версия прошивки |
| platform | string (enum) | Да | Платформа. Значения: aml (Amlogic), bb (BeagleBone), cv (Cvitek), stm (STM), xil (Xilinx) |
| install_type | string (enum) | Да | Тип установки. Значения: sd, nand |
| build_time | string | Да | Время сборки |
| build_name | string | Нет | Имя сборки |
| build_uuid | string | Нет | UUID сборки |
| miner | string | Да | Отображаемое имя майнера |
| model | string | Да | Код модели майнера |
| algorithm | string (enum) | Да | Алгоритм майнинга. Значения: sha256d, scrypt, unknown |
| hr_measure | string (enum) | Да | Единица измерения хешрейта. Значения: GH/s, MH/s, N/A |
| serial | string | Да | Серийный номер |
| system | object (SystemInfo) | Да | Информация о системе (память, ОС, сеть, uptime и т. д.) см. раскрытие ниже |
Вложенный объект system ( SystemInfo ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| mem_total | integer (int32) | Да | Общий объём памяти, неотрицательный |
| mem_free | integer (int32) | Да | Свободная память, неотрицательная |
| mem_free_percent | integer (int32) | Да | Процент свободной памяти, неотрицательный |
| mem_buf | integer (int32) | Да | Память, занятая буферами, неотрицательная |
| mem_buf_percent | integer (int32) | Да | Процент памяти под буферами, неотрицательный |
| os | string | Да | Название операционной системы |
| miner_name | string | Да | Имя майнера в системе |
| file_system_version | string | Да | Версия файловой системы |
| uptime | string | Да | Время работы системы без перезагрузки |
| network_status | object (NetworkStatus) | Да | Сетевой статус — см. раскрытие ниже |
Вложенный объект network_status (NetworkStatus):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| mac | string | Да | MAC-адрес сетевого интерфейса |
| ip | string | Да | Текущий IP-адрес |
| netmask | string | Да | Маска подсети |
| gateway | string | Да | Адрес шлюза |
| dns | array of string | Да | Список DNS-серверов |
| hostname | string | Да | Имя хоста устройства |
| dhcp | boolean | null | Нет | Получен ли адрес по DHCP |
Локализация (подсветка/поиск) майнера. Возвращает текущее состояние функции. Авторизация не требуется.
Ответ 200 (OK): LocateMinerStatus
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| is_enabled | boolean | Да | Включение/выключение функции локализации майнера |
Блокировка майнера (сброс текущей сессии). Требует авторизации (bearerAuth).
Ответ 200 (OK): тело отсутствует.
Блокировка прочих сессий майнера кроме текущей. Требует авторизации (bearerAuth).
Ответ 200 (OK): тело отсутствует.
Тело запроса: UnlockScreenBody
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| pw | string | Да | Пароль целевого устройства (устройств) |
Чтение файла лога по типу. Тип * (все логи) для этого маршрута не реализован. Авторизация не требуется.
Параметр пути:
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| log_type | string (enum) | Да | Тип лога. Значения: status, miner, autotune, pool, hwscan, system, messages, api, * (все — не реализовано для этого маршрута). Значения указываются строчными буквами |
⚠️На практике реально используются:
status,miner,hwscan,autotune,system. Значения указываются строчными буквами.
Ответ 200 (OK): файл лога (тело без описанной схемы).
Очистка логов указанного типа. Требует авторизации.
Параметр пути:
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| log_type | string (enum) | Да | Тип лога. Значения: status, miner, autotune, pool, hwscan, system, messages, api, * |
⚠️ На практике реально используются:
status,miner,hwscan,autotune. Значения указываются строчными буквами.
Ответ 200 (OK): тело отсутствует (Logs was cleared successfully).
Получение метрик майнера за интервал времени с усреднением по шагу.
Параметры запроса (query):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| time_slice | integer (int32) | Нет | Кол-во секунд до текущего момента. Макс. 3 дня (259200), по умолчанию 1 день (86400) |
| step | integer (int32) | Нет | Шаг ресемплинга (сек) для среднего, по умолчанию 15 мин (900) |
Ответ 200 (OK): MetricsReply
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| timezone | string (enum) | Да | Часовой пояс. Значения: GMT+1…GMT+12, GMT, GMT-1…GMT-11 |
| metrics | array (TimeRecord_MetricsData) | Да | Записи метрик со временем (см. ниже) |
| annotations | array (TimeRecord_MetricAnnotation) | Да | Аннотации событий со временем |
Вложенный metrics[].data ( MetricsData ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| time | integer (int64) | Да | UNIX-время записи |
| hashrate | number (double) | Да | Хешрейт |
| pcb_max_temp | integer (int32) | Да | Макс. температура PCB |
| chip_max_temp | integer (int32) | Да | Макс. температура чипа |
| fan_duty | integer (int32) | Да | Скорость вентиляторов (duty) |
| power_consumption | integer (int32) | Да | Потребляемая мощность |
Вложенный annotations[].data ( MetricAnnotation ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| time | integer (int64) | Да | UNIX-время события |
| type | string (enum) | Да | Тип события. Значения: start, stop, restart, reboot, overheat, disable_board, enable_board, fw_update |
| board_id | integer (int32) | null | Нет | Идентификатор платы |
Приостановка майнинга. Требует авторизации.
Ответ 200 (OK): тело отсутствует (Mining paused).
Перезапуск майнинга. Требует авторизации.
Ответ 200 (OK): тело отсутствует (Mining restart).
Возобновление майнинга. Требует авторизации.
Ответ 200 (OK): тело отсутствует (Mining resumed).
Запуск майнинга. Требует авторизации.
Ответ 200 (OK): тело отсутствует (Mining started).
Остановка майнинга. Требует авторизации.
Ответ 200 (OK): тело отсутствует (Mining stopped).
Переключение активного пула. Требует авторизации.
Тело запроса: SwitchPoolQuery
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| pool_id | integer (int32) | Да | Идентификатор пула, неотрицательный |
Пример тела запроса:
{
"pool_id": 1
}
Ответ 200 (OK): тело отсутствует (Pool was switched successfully).
Обновление настроек троттлинга. Требует авторизации.
Ответ 200 (OK): SaveConfigResult
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| restart_required | boolean | Да | Требуется перезапуск майнера для применения конфигурации |
| reboot_required | boolean | Да | Требуется перезагрузка майнера для применения |
Тело запроса: ThrottleSettings
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| percent | integer (int32) | Да | Процент троттлинга, от 20 до 100 |
Получение информации о модели майнера (алгоритм, серия, платформа, топология плат, охлаждение, разгон). Авторизация не требуется.
Ответ 200 (OK): MinerModelInfo
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| full_name | string | Да | Отображаемое имя майнера |
| model | string | Да | Код модели майнера |
| algorithm | string (enum) | Да | Алгоритм. Значения: sha256d, scrypt |
| series | string (enum) | Да | Серия. Значения: l7, l9, x19, x21 |
| platform | string (enum) | Да | Платформа. Значения: aml, bb, cv, stm, xil |
| install_type | string (enum) | Да | Тип установки. Значения: sd, nand |
| hr_measure | string (enum) | Да | Единица хешрейта. Значения: GH/s, MH/s |
| serial | string | Да | Серийный номер |
| chain | object (ModelInfoBoard) | Да | Параметры платы: chips_per_chain, chips_per_domain, num_chains, topology |
| cooling | object (CoolingConsts) | Да | Константы охлаждения: min_fan_pwm, min_target_temp, max_target_temp, fan_min_count |
| overclock | object (Overclock) | Да | Пределы разгона (напряжение, частота, лимит мощности и т. д.) |
Вложенный объект chain (ModelInfoBoard):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
chips_per_chain | integer | Да | Количество чипов на одной хеш-плате. |
chips_per_domain | integer | Да | Количество чипов в одном домене питания. |
num_chains | integer | Да | Количество хеш-плат. |
topology | object (Topology) | Да | Схема расположения чипов на хеш-плате. |
Вложенный в chain объект topology(Topology):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
chips | array | Да | Двумерный массив, описывающий схему расположения чипов на хеш-плате. Каждый элемент содержит идентификаторы чипов в соответствии с их физическим расположением. |
num_cols | integer | Да | Количество столбцов в схеме расположения чипов. |
num_rows | integer | Да | Количество строк в схеме расположения чипов. |
Вложенный объект cooling (CoolingConsts):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
min_fan_pwm | integer | Да | Минимально допустимая скорость вентиляторов (PWM, %). |
min_target_temp | integer | Да | Минимально допустимая целевая температура чипов. |
max_target_temp | integer | Да | Максимально допустимая целевая температура чипов. |
fan_min_count | object (MinerFanMinCount) | null | Да | Минимальное количество вентиляторов, необходимое для работы устройства. Для моделей без вентиляторов значение может быть null. |
Вложенный в cooling объект fan_min_count ( MinerFanMinCount ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| min | integer (int32) | Да | Минимальное количество вентиляторов, неотрицательное |
| max | integer (int32) | Да | Максимальное количество вентиляторов, неотрицательное |
| default | integer (int32) | Да | Значение по умолчанию, неотрицательное |
Вложенный объект overclock (Overclock):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
min_voltage | integer | Да | Минимальное напряжение. |
default_voltage | integer | Да | Напряжение по умолчанию. |
max_voltage | integer | Да | Максимальное напряжение. |
max_voltage_stock_psu | integer | Да | Максимальное напряжение при использовании штатного блока питания. |
min_freq | integer | Да | Минимальная частота. |
default_freq | integer | Да | Частота по умолчанию. |
warn_freq | integer | Да | Частота, при превышении которой отображается предупреждение. |
max_freq | integer | Да | Максимальная частота. |
max_power_limit | integer | Да | Максимально допустимый лимит мощности. |
power_metering | boolean | Да | Поддержка измерения потребляемой мощности. |
Чтение всех заметок в виде словаря «ключ — значение».
Ответ 200 (OK): объект (словарь)
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| (произвольный ключ) | string | — | Значение заметки; ключи — произвольные строки |
Тело запроса: NoteKeyValue
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| key | string | Да | Ключ заметки |
| value | string | Да | Значение заметки |
Пример тела запроса:
{
"key": "pool_reminder",
"value": "string1"
}
Ответ 200 (OK): тело отсутствует (Note add successfully).
Получение одной заметки по ключу.
Параметр пути:
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| note | string | Да | Ключ заметки |
Пример запроса: GET {{baseUrl}}/notes/pool_reminder
Ответ 200 (OK): NoteValue
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| value | string | Да | Значение заметки |
Обновление заметки по ключу. Требует авторизации.
Параметр пути:
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| note | string | Да | Ключ заметки |
Тело запроса: NoteValue
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| value | string | Да | Значение заметки |
Пример запроса: PUT {{baseUrl}}/notes/pool_reminder с телом:
{
"value": "string1111"
}
Ответ 200 (OK): тело отсутствует (Notes add successfully).
Удаление заметки по ключу. Требует авторизации.
Параметр пути:
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| note | string | Да | Ключ заметки |
Ответ 200 (OK): тело отсутствует (Note delete successfully).
Сводка по производительности: текущий пресет и настройки переключателя пресетов.
Ответ 200 (OK): PerfSummary
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| preset_switcher | object (PresetSwitcherRaw) | Да | Настройки переключателя пресетов (см. ниже) |
| current_preset | object (CurrentPreset) | null | Нет | Текущий пресет (name, pretty, status, globals) |
Вложенный объект PresetSwitcherRaw :
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| enabled | boolean | null | Нет | Включён ли переключатель |
| autochange_top_preset | boolean | null | Нет | Автосмена верхнего пресета |
| check_time | integer (int32) | null | Нет | Период проверки (сек), 60–600 |
| decrease_temp | integer (int32) | null | Нет | Температура понижения, 25–90 |
| rise_temp | integer (int32) | null | Нет | Температура повышения, макс. 85 |
| ignore_fan_speed | boolean | null | Нет | Игнорировать скорость вентиляторов |
| min_preset | string | null | Нет | Минимальный пресет |
| top_preset | string | null | Нет | Макс. пресет, до которого может переключать |
Вложенный объект current_preset ( CurrentPreset ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| name | string | Да | Идентификатор (id) пресета |
| pretty | string | Да | Человекочитаемое имя пресета |
| status | string (enum) | Да | Статус пресета. Значения: untuned, tuned |
| globals | object (GlobalsRaw) | null | Нет | Глобальные частота/напряжение (freq, volt) — присутствует только когда переключатель пресетов отключён |
Получение всех настроек майнера. Требует авторизации (apikeyAuth).
Ответ 200 (OK): ViewConfig
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| miner | object (MinerConfigRaw) | Да | Настройки майнера: cooling, misc, overclock, pools |
| ui | object (UiSettings) | Да | Настройки интерфейса (тема, локаль, часовой пояс и т. д.) |
| regional | object (RegionalSettings) | Да | Региональные настройки: timezone.current |
| network | object (NetworkConfFile) | Да | Сетевая конфигурация: hostname, dhcp, ipaddress, netmask, gateway, dnsservers |
| password | object (PasswordChange) | null | Нет | Смена пароля: current, pw |
Вложенный объект ui ( UiSettings ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| theme | string (enum) | null | Нет | Тема. Значения: light, dark, auto |
| locale | string (enum) | null | Нет | Локаль. Значения: ru, en, fa, ua, zh, pt, ka |
| timezone | string (enum) | null | Нет | Часовой пояс. Значения: GMT+1…GMT+12, GMT, GMT-1…GMT-11 |
| dark_side_pane | boolean | null | Нет | Тёмная боковая панель |
| disable_animation | boolean | null | Нет | Отключение анимации |
| consts | object (Consts) | null | Нет | Константы для интерфейса — см. раскрытие ниже |
Вложенный в ui.consts объект ( Consts ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| cooling | object (CoolingConsts) | Да | Те же поля, что уже раскрыты в разделе 6.5.28 (GET /model): min_fan_pwm, min_target_temp, max_target_temp, fan_min_count |
| overclock | object (Overclock) | Да | Те же поля, что уже раскрыты в разделе 6.5.28 (GET /model) |
| timezones | array | Нет | Список доступных часовых поясов для отображения в UI, пары «код → название» |
Вложенный объект regional ( RegionalSettings ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| timezone | object (TimezoneSettings) | Да | Обёртка над часовым поясом — единственное поле current (enum, те же значения GMT±N) |
Вложенный объект network ( NetworkConfFile ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| hostname | string | Да | Имя хоста устройства |
| dhcp | boolean | Да | Получен ли адрес по DHCP |
| ipaddress | string | Да | IP-адрес |
| netmask | string | Да | Маска подсети |
| gateway | string | Да | Адрес шлюза |
| dnsservers | array of string | Да | Список DNS-серверов |
Вложенный объект password ( PasswordChange ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| current | string | Да | Текущий пароль |
| pw | string | Да | Новый пароль |
Вложенный в ViewConfig объект miner ( MinerConfigRaw ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| cooling | object (CoolingSettingsRaw) | null | Нет | Настройки охлаждения — см. раскрытие ниже |
| misc | object (AdvancedSettingsRaw) | null | Нет | Дополнительные (продвинутые) настройки — см. раскрытие ниже |
| overclock | object (OverclockSettingsRaw) | null | Нет | Настройки разгона — см. раскрытие ниже |
| pools | array | null | Нет | Список из 3 пулов (фиксированная тройка) — см. раскрытие ниже |
Вложенный в miner объект cooling ( CoolingSettingsRaw ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| fan_max_duty | integer (int32) | null | Нет | Максимальная скорость вентиляторов, 0–100 |
| fan_min_duty | integer (int32) | null | Нет | Минимальная скорость вентиляторов, 0–100 |
| fan_min_count | integer (int32) | null | Нет | Минимальное количество вентиляторов, неотрицательное |
| min_startup_water_temp | integer (int32) | null | Нет | Минимальная температура воды при запуске, 0–20 |
| mode | object (ModeRaw) | null | Нет | Режим работы вентиляторов — см. раскрытие ниже |
Вложенный в cooling объект mode ( ModeRaw ) — один из трёх вариантов (по значению name):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| name | string (enum) | Да | Вариант режима. Значения: auto, manual, immers |
| param | integer (int32) | Да (только для auto/manual) | Параметр режима, неотрицательный. Отсутствует при name: "immers" |
Вложенный в miner объект misc (AdvancedSettingsRaw) — все поля необязательные (null, если не заданы):
| Параметр | Тип данных | Описание |
|---|---|---|
| allow_disabling_chains_without_pics | boolean | null | Разрешить отключение плат без PIC-контроллеров |
| auto_chip_throttling | boolean | null | Автоматическая регулировка частоты чипов по температуре |
| automatic_pause_on_boot | boolean | null | Автопауза майнинга сразу после загрузки |
| bitmain_disable_volt_comp | boolean | null | Отключить компенсацию напряжения |
| disable_chain_break_protection | boolean | null | Отключить защиту от обрыва платы |
| disable_restart_unbalanced | boolean | null | Отключить перезапуск при разбалансировке |
| disable_volt_checks | boolean | null | Отключить проверки напряжения |
| downscale_preset_on_failure | boolean | null | Автопонижение пресета при перегреве/ошибке платы |
| ignore_broken_sensors | boolean | null | Игнорировать неисправные датчики |
| ignore_chip_sensors | boolean | null | Игнорировать датчики чипов |
| keep_hashing_when_offline | boolean | null | Продолжать майнинг при отсутствии сети |
| max_restart_attempts | integer (int32) | null | Максимальное число попыток перезапуска, неотрицательное |
| max_startup_delay_time | integer (int32) | null | Максимальная задержка запуска майнинга, 0–300 сек |
| min_startup_delay_time | integer (int32) | null | Минимальная задержка запуска майнинга, 0–300 сек |
| min_operational_chains | integer (int32) | null | Минимальное число рабочих плат, неотрицательное |
| power_limit | integer (int32) | null | Лимит мощности, неотрицательный |
| power_limit_enabled | boolean | null | Включён ли лимит мощности |
| quick_start | boolean | null | Быстрый старт |
| quiet_mode | boolean | null | Тихий режим |
| restart_hashrate | integer (int32) | null | Порог хешрейта для перезапуска, в процентах, 0–100 (0 — отключено) |
| restart_temp | integer (int32) | null | Температура для перезапуска, 50–120 |
| restore_miner_state_on_reboot | boolean | null | Восстанавливать состояние майнера после перезагрузки/отключения питания |
| retune_on_chain_break | boolean | null | Автотюнинг при обрыве платы |
| tuner_bad_chip_hr_threshold | integer (int32) | null | Порог хешрейта для пометки чипа как «плохой» в автотюне, 20–80 |
Вложенный в miner объект overclock ( OverclockSettingsRaw ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| preset | string | null | Нет | Имя текущего профиля разгона |
| globals | object (GlobalsRaw) | null | Нет | Глобальные частота/напряжение — см. раскрытие ниже |
| chains | array (BoardRaw) | null | Нет | Настройки разгона по платам — см. раскрытие ниже |
| preset_switcher | object (PresetSwitcherRaw) | null | Нет | Настройки автопереключения пресетов — те же поля, что в разделе 6.5.35 (GET /perf-summary) |
Вложенный в overclock объект globals ( GlobalsRaw ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| freq | integer (int32) | null | Нет | Глобальная частота, неотрицательная |
| volt | integer (int32) | null | Нет | Глобальное напряжение, неотрицательное |
Вложенный в overclock объект chains[] ( BoardRaw ) — по одному элементу массива на каждую плату:
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| freq | integer (int32) | null | Нет | Частота платы. 0 означает «использовать значение из globals» |
| chips | array of integer (int32) | null | Нет | Частоты по каждому чипу платы. 0 в элементе — использовать частоту платы |
| disabled | boolean | null | Нет | Плата отключена |
Сохранение настроек майнера. Требует авторизации.
Ответ 200 (OK): SaveConfigResult
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| restart_required | boolean | Да | Требуется перезапуск майнера для применения конфигурации |
| reboot_required | boolean | Да | Требуется перезагрузка майнера для применения |
Тело запроса: InputConfig (все поля необязательные, nullable)
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| miner | object (MinerConfigRaw) | null | Нет | Настройки майнера |
| network | object (InputNetworkConfFile) | null | Нет | Сеть + enable_network_check |
| password | object (PasswordChange) | null | Нет | Смена пароля |
| regional | object (RegionalSettings) | null | Нет | Региональные настройки |
| ui | object (UiSettings) | null | Нет | Настройки интерфейса |
Вложенный объект network ( InputNetworkConfFile ) — это NetworkConfFile плюс одно дополнительное поле:
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| hostname | string | Да | Имя хоста устройства |
| dhcp | boolean | Да | Получать ли адрес по DHCP |
| ipaddress | string | Да | IP-адрес |
| netmask | string | Да | Маска подсети |
| gateway | string | Да | Адрес шлюза |
| dnsservers | array of string | Да | Список DNS-серверов |
| enable_network_check | boolean | Нет | Включить проверку сетевого подключения (поле есть только у InputNetworkConfFile, отсутствует в обычном NetworkConfFile) |
Вложенный объект password ( PasswordChange ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| current | string | Да | Текущий пароль |
| pw | string | Да | Новый пароль |
Вложенный объект regional ( RegionalSettings ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| timezone | object (TimezoneSettings) | Да | Обёртка над часовым поясом |
Вложенный в regional.timezone объект ( TimezoneSettings ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| current | string (enum) | Да | Часовой пояс. Значения: GMT+1…GMT+12, GMT, GMT-1…GMT-11 |
Вложенный объект ui ( UiSettings ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| theme | string (enum) | null | Нет | Тема. Значения: light, dark, auto |
| locale | string (enum) | null | Нет | Локаль. Значения: ru, en, fa, ua, zh, pt, ka |
| timezone | string (enum) | null | Нет | Часовой пояс. Значения: GMT+1…GMT+12, GMT, GMT-1…GMT-11 |
| dark_side_pane | boolean | null | Нет | Тёмная боковая панель |
| disable_animation | boolean | null | Нет | Отключение анимации |
| consts | object (Consts) | null | Нет | Константы для отображения в UI (только для чтения по смыслу, обычно не передаются при сохранении) — см. раскрытие ниже |
Вложенный в ui.consts объект ( Consts ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| cooling | object (CoolingConsts) | Да | Те же поля, что уже раскрыты в разделе 6.5.28 (GET /model): min_fan_pwm, min_target_temp, max_target_temp, fan_min_count |
| overclock | object (Overclock) | Да | Те же поля, что уже раскрыты в разделе 6.5.28 (GET /model) |
| timezones | array | Нет | Список доступных часовых поясов для отображения в UI, пары «код → название». Актуально только для GET-запросов, для UPDATE-запросов можно игнорировать |
Резервное копирование настроек. Требует авторизации. Возвращает бинарный файл.
Ответ 200 (OK): бинарные данные (application/octet-stream, массив байт). Cервер отдаёт архив ( .tar.gz ), который при распаковке содержит набор конфигурационных файлов майнера.
Реальное содержимое архива (пример):
| Файл | Тип | Что внутри |
|---|---|---|
system.conf | CONF | Системные настройки |
password | — | Пароль устройства |
network.conf | CONF | Сетевые настройки — соответствует NetworkConfFile (hostname, dhcp, ipaddress, netmask, gateway, dnsservers) |
dashd.conf | CONF | Настройки службы демона майнинга/статуса |
cgminer.conf | CONF | Основной конфиг майнинга: пулы, overclock, дополнительные настройки |
autotune.json | JSON | Сохранённые пресеты автотюна — соответствует данным из GET /autotune/presets |
apikeys.json | JSON | Список созданных API-ключей — соответствует ApiKeysJsonItem (раздел 2–4). Пустой массив [], если ключей нет |
Сброс настроек к заводским. Требует авторизации. После операции система перезагрузится.
Ответ 200 (OK): RebootAfter
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| after | integer (int64) | Да | Через сколько секунд система перезагрузится (по умолчанию 3) |
Восстановление настроек из файла. Требует авторизации. При активной гарантии вернётся 403 (нужно сначала отменить гарантию: /cancel-warranty). После операции система перезагрузится.
Ответ 200 (OK): RebootAfter
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| after | integer (int64) | Да | Через сколько секунд система перезагрузится (по умолчанию 3) |
Тело запроса: SchemaSettingsRestore (multipart/form-data)
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| file | string (binary) | Да | Файл резервной копии настроек |
Получение статуса майнера (состояние, троттлинг, требования перезапуска, локализация, гарантия). Авторизация не указана.
Ответ 200 (OK): StatusPane
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| miner_state | string (enum) | Да | Состояние майнера. Значения: mining, initializing, starting, auto-tuning, restarting, shutting-down, stopped, failure |
| throttled | integer (int32) | Да | Уровень троттлинга, 20–100 |
| miner_state_time | integer (int64) | Да | Время в текущем состоянии (пока реализовано для mining) |
| description | string | null | Нет | Описание при статусе failure |
| failure_code | integer (int32) | null | Нет | Код ошибки |
| restart_required | boolean | Да | Требуется перезапуск |
| reboot_required | boolean | Да | Требуется перезагрузка |
| find_miner | boolean | Да | Флаг функции локализации майнера (по умолчанию false) |
| unlocked | boolean | Да | Статус блокировки экрана (авторизация пройдена) |
| unlock_timeout | integer (int64) | null | Нет | Таймаут разблокировки |
| warranty | string (enum) | Нет | Статус гарантии. Значения: active, inactive, expired, cancelled, not_provided |
Общая сводка по майнеру (статистика хешрейта, температур, мощности, пулов, плат, охлаждения). Требует авторизации.
Ответ 200 (OK): Summary
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| miner | object (AntmMinerStats) | null | Нет | Статистика майнера (см. ключевые поля ниже) |
Ключевые поля AntmMinerStats :
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| miner_status | object (MinerStatus) | Да | Статус: miner_state, throttled, miner_state_time |
| miner_type | string | Да | Тип майнера |
| hr_stock | number (float) | Да | Стоковый хешрейт |
| hr_realtime | number (float) | Да | Хешрейт в реальном времени |
| hr_nominal | number (float) | Да | Номинальный хешрейт |
| hr_average | number (float) | Да | Средний хешрейт |
| average_hashrate | number (float) | Да | Устарело. То же, что hr_average, но в MH/s |
| instant_hashrate | number (float) | Да | Устарело. То же, что hr_realtime, но в MH/s |
| pcb_temp | object (TempRange) | Да | Диапазон температуры PCB: min, max |
| chip_temp | object (TempRange) | Да | Диапазон температуры чипов: min, max |
| power_consumption | integer (int32) | Да | Потребляемая мощность |
| power_efficiency | number (float) | Да | Энергоэффективность |
| power_usage | integer (int32) | Да | Устарело. То же, что power_efficiency |
| hw_errors | integer (int32) | Да | Аппаратные ошибки |
| hw_errors_percent | number (float) | Да | Процент аппаратных ошибок |
| hr_error | number (float) | Да | Уровень ошибок хешрейта |
| devfee | number (float) | Да | Комиссия разработчика |
| devfee_percent | number (float) | Да | Процент комиссии разработчика |
| pools | array (PoolStats) | Да | Статистика пулов (см. ниже) |
| cooling | object (Cooling) | Да | Охлаждение: fan_num, fans, settings, fan_duty |
| chains | array (AntmBoard) | Да | Платы с детальной статистикой |
| found_blocks | integer (int32) | Да | Найдено блоков |
| best_share | integer (int64) | Да | Лучший share |
| restart_count | integer | Да | Кол-во перезапусков |
| psu | object (AntmPsuInfo) | null | Нет | Информация о БП |
Вложенный объект pools[] ( PoolStats ) — по одному элементу массива на каждый пул:
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| id | integer (int32) | Да | Идентификатор пула, неотрицательный |
| url | string | Да | Адрес пула |
| user | string | Да | Имя пользователя/воркер |
| pool_type | string (enum) | Да | Тип пула. Значения: UserPool, DevFee, Refund |
| status | string (enum) | Да | Статус пула. Значения: offline, working, disabled, active, rejecting, unknown |
| diff | string | Да | Текущая сложность (в виде строки, как отображает cgminer) |
| diffa | number (double) | Да | Средняя принятая сложность |
| accepted | integer (int32) | Да | Количество принятых шар |
| rejected | integer (int32) | Да | Количество отклонённых шар |
| stale | integer (int32) | Да | Количество устаревших (stale) шар |
| ls_diff | number (float) | Да | Сложность последней принятой шары |
| ls_time | string | Да | Время последней принятой шары |
| ping | integer (int32) | Да | Пинг до пула, мс |
Вложенный объект cooling ( Cooling ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| fan_num | integer | Да | Количество вентиляторов, неотрицательное |
| fan_duty | integer (int32) | Да | Текущая скорость вентиляторов (duty), общая |
| fans | array (Fan) | Да | Список вентиляторов — см. раскрытие ниже |
| settings | object (FanSettings) | Да | Настройки режима вентиляторов — см. раскрытие ниже |
Вложенный в cooling объект fans[] ( Fan ) — по одному элементу массива на каждый физический вентилятор:
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| id | integer | Да | Идентификатор вентилятора, неотрицательный |
| rpm | integer (int32) | Да | Текущие обороты в минуту |
| max_rpm | integer (int32) | Да | Максимальные обороты в минуту, неотрицательное |
| status | string (enum) | Да | Статус вентилятора. Значения: ok, lost (потеряна связь с вентилятором) |
Вложенный в cooling объект settings ( FanSettings ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| mode | object (FanSettingsMode) | Да | Режим работы вентиляторов — один из трёх вариантов по значению name, см. ниже |
Вложенный в settings объект mode ( FanSettingsMode ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| name | string (enum) | Да | Вариант режима. Значения: auto, manual, immersion |
| param | integer (int32) | Да (только для auto/manual) | Параметр режима, неотрицательный. Отсутствует при name: "immersion" |
Вложенный объект psu ( AntmPsuInfo ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| psu_power_metering | boolean | null | Нет | Поддержка измерения мощности блоком питания |
| temps | object (AntmPsuTemps) | null | Нет | Температуры блока питания — см. раскрытие ниже |
Вложенный в psu объект temps ( AntmPsuTemps ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| llc1_temp | integer (int32) | null | Нет | Температура LLC-каскада 1 |
| llc2_temp | integer (int32) | null | Нет | Температура LLC-каскада 2 |
| pfc_temp | integer (int32) | null | Нет | Температура PFC-каскада |
Вложенный объект chains[] ( AntmBoard ) — по одному элементу массива на каждую плату:
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| id | integer | Да | Идентификатор платы, неотрицательный |
| frequency | number (float) | Да | Частота платы |
| voltage | integer (int32) | Да | Напряжение платы |
| power_consumption | integer (int32) | Да | Потребляемая мощность платы |
| hashrate_ideal | number (float) | Да | Номинальный (идеальный) хешрейт платы |
| hashrate_rt | number (float) | Да | Хешрейт платы в реальном времени |
| hashrate_percentage | number (float) | Да | Процент от номинального хешрейта |
| hr_error | number (float) | Да | Уровень ошибок хешрейта платы |
| hw_errors | integer (int32) | Да | Количество аппаратных ошибок платы |
| pcb_temp | object (TempRange) | Да | Диапазон температуры PCB платы: min, max |
| chip_temp | object (TempRange) | Да | Диапазон температуры чипов платы: min, max |
| chip_statuses | object (BoardChipStatuses) | Да | Сводка по состоянию чипов платы — см. раскрытие ниже |
| status | object (BoardStatus) | Да | Статус платы — см. раскрытие ниже |
| inlet_water_temp | integer (int32) | null | Нет | Температура воды на входе (для жидкостного охлаждения), неотрицательная |
| outlet_water_temp | integer (int32) | null | Нет | Температура воды на выходе (для жидкостного охлаждения), неотрицательная |
Вложенный в chains[] объект chip_statuses ( BoardChipStatuses ) — количество чипов по категориям:
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| red | integer (int32) | Да | Количество чипов в статусе «красный» (наихудшее состояние), неотрицательное |
| orange | integer (int32) | Да | Количество чипов в статусе «оранжевый» (промежуточное состояние), неотрицательное |
| grey | integer (int32) | Да | Количество чипов в статусе «серый» (нормальное состояние), неотрицательное |
Вложенный в chains[] объект status ( BoardStatus ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| state | string (enum) | Да | Состояние платы. Значения: initializing, mining, stopped, failure, disconnected, disabled, unknown |
| description | string | null | Нет | Текстовое описание состояния (обычно заполняется при failure) |
Перезагрузка системы. Требует авторизации.
Ответ 200 (OK): RebootAfter
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| after | integer (int64) | Да | Через сколько секунд система перезагрузится (по умолчанию 3) |
Получение настроек интерфейса (тема, локаль, часовой пояс, константы охлаждения/разгона, таймзоны).
Ответ 200 (OK): UiSettings
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| theme | string (enum) | null | Нет | Тема. Значения: light, dark, auto |
| locale | string (enum) | null | Нет | Локаль. Значения: ru, en, fa, ua, zh, pt, ka |
| timezone | string (enum) | null | Нет | Часовой пояс. Значения: GMT+1…GMT+12, GMT, GMT-1…GMT-11 |
| dark_side_pane | boolean | null | Нет | Тёмная боковая панель |
| disable_animation | boolean | null | Нет | Отключение анимации |
| consts | object (Consts) | null | Нет | Константы: cooling, overclock, timezones |
Вложенный в UiSettings объект ( Consts ):
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| cooling | object (CoolingConsts) | Да | Те же поля, что уже раскрыты в разделе 6.5.28 (GET /model): min_fan_pwm, min_target_temp, max_target_temp, fan_min_count |
| overclock | object (Overclock) | Да | Те же поля, что уже раскрыты в разделе 6.5.28 (GET /model) |
| timezones | array | Нет | Список доступных часовых поясов для отображения в UI, пары «код → название» |
Разблокировка (аутентификация по паролю). Возвращает JWT-токен.
Ответ 200 (OK): UnlockSuccess
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| token | string | Да | JWT-токен авторизации |
Тело запроса: UnlockScreenBody
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| pw | string | Да | Пароль целевого устройства (устройств) |
⚠️ Эндпоинт больше не используется. Помечен как
deprecatedв спецификации и сохранён только для обратной совместимости со старыми клиентами. Для новых интеграций используйте актуальныйPOST /locate-miner(раздел 6.5.15).
ErrDescr (используется в ответах 400, 409, 500, 507 и др.)
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| err | string | Да | Текст ошибки |