Referencia de Endpoints
Activación de la garantía del miner. Requiere autorización. Devuelve el estado de la garantía.
Respuesta 200: WarrantyStatus Respuesta 200 (OK): array ApiKeysJsonItem
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| success | boolean | Sí | Indicador de éxito de la operación |
| warranty | string (enum) | No | Estado de la garantía. Valores: active — activa; inactive — inactiva; expired — expirada; cancelled — cancelada; not_provided — no proporcionada |
Obtención de la lista de API-keys. Requiere autorización. Devuelve un array de claves.
Respuesta 200 (OK): array ApiKeysJsonItem
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| key | string | Sí | API-key de exactamente 32 caracteres de longitud |
| description | string | Sí | Descripción de la clave |
Adición de una nueva API-key. Requiere autorización. En el cuerpo de la solicitud se transmite la clave y la descripción (AddApikeyQuery = ApiKeysJsonItem).
Respuesta 200 (OK): AddApiKeyRes
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| status | string (enum) | Sí | Resultado de la operación. Valores: inserted — clave añadida; updated — clave actualizada; nochanges — sin cambios |
Eliminación de una API-key. Requiere autorización. En el cuerpo de la solicitud se transmite la clave (DeleteApikeyQuery).
Respuesta 200 (OK): cuerpo ausente (Key deleted successfully).
Verificación de autorización. Devuelve información sobre el tiempo restante hasta el final del bloqueo temporal del dispositivo.
Respuesta 200 (OK): AuthCheck
Si el dispositivo no está en bloqueo temporal, se devuelve un objeto vacío:
{}
Si el dispositivo está en bloqueo temporal, la respuesta incluye el campo unlock_timeout, que contiene el número de segundos restantes hasta el final del bloqueo:
{
"unlock_timeout":58
}
Nota: la ausencia del campo
unlock_timeoutes equivalente a un valornulle indica que no hay bloqueo temporal.
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| unlock_timeout | integer (int64) | null | No | Tiempo de espera de bloqueo (seg), valor no negativo |
Obtención de la lista de Presets de Auto-tune. Requiere autorización. Devuelve un array de Presets con la configuración de tuning.
Respuesta 200 (OK): array AutotunePresetDto
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| name | string | Sí | Identificador (id) del Preset |
| pretty | string | Sí | Nombre legible del Preset |
| status | string (enum) | Sí | Estado del Preset. Valores: untuned — no configurado; tuned — configurado con éxito |
| tune_settings | object (AutotuneResultsItem) | null | No | Resultados del tuning (ver abajo) |
Objeto anidado tune_settings ( AutotuneResultsItem ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| hashrate | integer (int32) | Sí | Hashrate, no negativo |
| volt | integer (int32) | Sí | Voltaje, no negativo |
| freq | integer (int32) | Sí | Frecuencia, no negativa |
| chains | array (AutotuneBoard) | Sí | Lista de Hashboards: freq (int32), chips (array int32), serial (string | null) |
| modified | boolean | Sí | Indicador de modificación manual |
| date | string | null | No | Fecha de tuning |
Restablecimiento de la lista especificada de perfiles de Auto-tune. Requiere autorización.
Respuesta 200 (OK): cuerpo ausente.
Cuerpo de la solicitud: AutotuneReset
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| presets | array of string | Sí | Lista de Presets para restablecer |
| restart | boolean | Sí | Reinicio después de eliminar los Presets |
Restablecimiento de todos los perfiles de Auto-tune. Requiere autorización.
Respuesta 200 (OK): cuerpo ausente.
Cuerpo de la solicitud: AutotuneResetAll
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| restart | boolean | Sí | Reinicio después del restablecimiento |
Obtención de las Hashboards del miner con detalles de chips y sensores. No requiere autorización.
Respuesta 200 (OK): array AntmBoardChips
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| id | integer | Sí | Identificador de la Hashboard, no negativo |
| status | object (CgBoardStatus) | Sí | Estado de la Hashboard: state (enum), failure_message (string | null) |
| hr_realtime | number (float) | Sí | Hashrate en tiempo real |
| hr_nominal | number (float) | Sí | Hashrate nominal |
| freq | number (float) | Sí | Frecuencia |
| sensors | array (AntmChipSensor) | Sí | Sensores: state, board, chip, loc |
| chips | array (AntmChip) | Sí | Chips (ver abajo) |
Objeto anidado status ( CgBoardStatus ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| state | string (enum) | Sí | Estado de la Hashboard. Valores: initializing, mining, stopped, failure, disconnected, disabled, unknown |
| failure_message | string | null | No | Descripción textual del error (normalmente se rellena en caso de failure) |
Objeto anidado sensors[] ( AntmChipSensor ) — un elemento del array por cada sensor:
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| state | string (enum) | Sí | Estado del sensor. Valores: init, ready, measure, error, unknown |
| board | integer (int32) | Sí | Número de la Hashboard a la que pertenece el sensor |
| chip | integer (int32) | Sí | Número del chip al que pertenece el sensor |
| loc | integer (int32) | Sí | Ubicación del sensor — se refiere a chip.id, no negativo |
Objeto anidado del chip AntmChip :
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| id | integer | Sí | Identificador del chip |
| hr | number (float) | Sí | Hashrate |
| freq | integer (int32) | Sí | Frecuencia |
| volt | integer (int32) | Sí | Voltaje |
| temp | number (float) | Sí | Temperatura |
| errs | integer (int32) | Sí | Cantidad de errores |
| grade | string (enum) | Sí | Calificación del chip. Valores: grey, orange, red |
| throttled | boolean | Sí | Indicador de throttling |
Cancelación de la garantía del miner. Requiere autorización.
Respuesta 200 (OK): WarrantyStatus
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| success | boolean | Sí | Indicador de éxito de la operación |
| warranty | string (enum) | No | Estado de la garantía. Valores: active, inactive, expired, cancelled, not_provided |
Obtención de la información de fábrica de las Hashboards del miner. No requiere autorización.
Respuesta 200 (OK): FactoryInfoReply
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| chains | array (FactoryInfoBoard) | null | No | Lista de Hashboards con datos de fábrica |
| has_pics | boolean | null | No | Presencia de Controladores PIC |
| hr_stock | number (double) | null | No | Hashrate de stock |
| psu_model | string | null | No | Modelo de la PSU |
| psu_serial | string | null | No | Número de serie de la PSU |
Objeto anidado: FactoryInfoBoard
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| id | integer (int32) | Sí | Identificador de la Hashboard |
| board_model | string | Sí | Modelo de la Hashboard |
| serial | string | Sí | Número de serie |
| chip_bin | integer (int32) | Sí | Bin de chips |
| freq | integer (int32) | Sí | Frecuencia |
| volt | integer (int32) | Sí | Voltaje |
| hashrate | number (double) | Sí | Hashrate |
Eliminación del Firmware y carga del Firmware de stock. Requiere autorización. Después de la operación, el sistema se reiniciará.
Respuesta 200 (OK): RebootAfter
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| after | integer (int64) | Sí | En cuántos segundos se reiniciará el sistema (por defecto 3), no negativo |
Cuerpo de la solicitud: FwRemoveParams
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| remove_stock_logs | boolean | Sí | ¿Eliminar los logs de stock? |
Actualización del Firmware. Requiere autorización. Después de la actualización, el sistema se reiniciará.
Respuesta 200: RebootAfter
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| after | integer (int64) | Sí | En cuántos segundos se reiniciará el sistema (por defecto 3) |
Cuerpo de la solicitud: SchemaFirmwareUpdate (multipart/form-data)
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| file | string (binary) | Sí | Archivo de Firmware |
| keep_settings | string (enum) | null | No | Guardar configuración. Valores: true, false |
Obtención de información general del miner (datos de Firmware + modelo, algoritmo, sistema). No requiere autorización.
Respuesta 200 (OK): InfoJson
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| fw_name | string | Sí | Nombre del Firmware |
| fw_version | string | Sí | Versión del Firmware |
| platform | string (enum) | Sí | Plataforma. Valores: aml (Amlogic), bb (BeagleBone), cv (Cvitek), stm (STM), xil (Xilinx) |
| install_type | string (enum) | Sí | Tipo de instalación. Valores: sd, nand |
| build_time | string | Sí | Tiempo de compilación |
| build_name | string | No | Nombre de la compilación |
| build_uuid | string | No | UUID de la compilación |
| miner | string | Sí | Nombre visible del miner |
| model | string | Sí | Código del modelo del miner |
| algorithm | string (enum) | Sí | Algoritmo de minería. Valores: sha256d, scrypt, unknown |
| hr_measure | string (enum) | Sí | Unidad de medida del Hashrate. Valores: GH/s, MH/s, N/A |
| serial | string | Sí | Número de serie |
| system | object (SystemInfo) | Sí | Información del sistema (memoria, SO, red, uptime, etc.) ver detalles abajo |
Objeto anidado system ( SystemInfo ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| mem_total | integer (int32) | Sí | Memoria total, no negativa |
| mem_free | integer (int32) | Sí | Memoria libre, no negativa |
| mem_free_percent | integer (int32) | Sí | Porcentaje de memoria libre, no negativo |
| mem_buf | integer (int32) | Sí | Memoria ocupada por búferes, no negativa |
| mem_buf_percent | integer (int32) | Sí | Porcentaje de memoria para búferes, no negativo |
| os | string | Sí | Nombre del sistema operativo |
| miner_name | string | Sí | Nombre del miner en el sistema |
| file_system_version | string | Sí | Versión del sistema de archivos |
| uptime | string | Sí | Tiempo de actividad del sistema sin reiniciar |
| network_status | object (NetworkStatus) | Sí | Estado de red — ver detalles abajo |
Objeto anidado network_status (NetworkStatus):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| mac | string | Sí | Dirección MAC de la interfaz de red |
| ip | string | Sí | Dirección IP actual |
| netmask | string | Sí | Máscara de subred |
| gateway | string | Sí | Dirección de la puerta de enlace |
| dns | array of string | Sí | Lista de servidores DNS |
| hostname | string | Sí | Nombre de host del dispositivo |
| dhcp | boolean | null | No | ¿Se obtuvo la dirección por DHCP? |
Localización (iluminación/búsqueda) del miner. Devuelve el estado actual de la función. No requiere autorización.
Respuesta 200 (OK): LocateMinerStatus
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| is_enabled | boolean | Sí | Activación/desactivación de la función de localización del miner |
Bloqueo del miner (restablecimiento de la sesión actual). Requiere autorización (bearerAuth).
Respuesta 200 (OK): cuerpo ausente.
Bloqueo de otras sesiones del miner excepto la actual. Requiere autorización (bearerAuth).
Respuesta 200 (OK): cuerpo ausente.
Cuerpo de la solicitud: UnlockScreenBody
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| pw | string | Sí | Contraseña del dispositivo (o dispositivos) de destino |
Lectura de archivo de log por tipo. El tipo * (todos los logs) no está implementado para esta ruta. No requiere autorización.
Parámetro de ruta:
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| log_type | string (enum) | Sí | Tipo de log. Valores: status, miner, autotune, pool, hwscan, system, messages, api, * (todos — no implementado para esta ruta). Los valores se especifican en minúsculas |
⚠️En la práctica, se utilizan realmente:
status,miner,hwscan,autotune,system. Los valores se especifican en minúsculas.
Respuesta 200 (OK): archivo de log (cuerpo sin esquema descrito).
Limpieza de logs del tipo especificado. Requiere autorización.
Parámetro de ruta:
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| log_type | string (enum) | Sí | Tipo de log. Valores: status, miner, autotune, pool, hwscan, system, messages, api, * |
⚠️ En la práctica, se utilizan realmente:
status,miner,hwscan,autotune. Los valores se especifican en minúsculas.
Respuesta 200 (OK): cuerpo ausente (Logs was cleared successfully).
Obtención de métricas del miner para un intervalo de tiempo con promediado por paso.
Parámetros de consulta (query):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| time_slice | integer (int32) | No | Cantidad de segundos hasta el momento actual. Máx. 3 días (259200), por defecto 1 día (86400) |
| step | integer (int32) | No | Paso de remuestreo (seg) para el promedio, por defecto 15 min (900) |
Respuesta 200 (OK): MetricsReply
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| timezone | string (enum) | Sí | Zona horaria. Valores: GMT+1…GMT+12, GMT, GMT-1…GMT-11 |
| metrics | array (TimeRecord_MetricsData) | Sí | Registros de métricas con tiempo (ver abajo) |
| annotations | array (TimeRecord_MetricAnnotation) | Sí | Anotaciones de eventos con tiempo |
Objeto anidado metrics[].data ( MetricsData ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| time | integer (int64) | Sí | Tiempo UNIX del registro |
| hashrate | number (double) | Sí | Hashrate |
| pcb_max_temp | integer (int32) | Sí | Temperatura máxima de la PCB |
| chip_max_temp | integer (int32) | Sí | Temperatura máxima del chip |
| fan_duty | integer (int32) | Sí | Velocidad de los ventiladores (duty) |
| power_consumption | integer (int32) | Sí | Consumo de energía |
Objeto anidado annotations[].data ( MetricAnnotation ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| time | integer (int64) | Sí | Tiempo UNIX del evento |
| type | string (enum) | Sí | Tipo de evento. Valores: start, stop, restart, reboot, overheat, disable_board, enable_board, fw_update |
| board_id | integer (int32) | null | No | Identificador de la Hashboard |
Pausa de la minería. Requiere autorización.
Respuesta 200 (OK): cuerpo ausente (Mining paused).
Reinicio de la minería. Requiere autorización.
Respuesta 200 (OK): cuerpo ausente (Mining restart).
Reanudación de la minería. Requiere autorización.
Respuesta 200 (OK): cuerpo ausente (Mining resumed).
Inicio de la minería. Requiere autorización.
Respuesta 200 (OK): cuerpo ausente (Mining started).
Detención de la minería. Requiere autorización.
Respuesta 200 (OK): cuerpo ausente (Mining stopped).
Cambio del Pool activo. Requiere autorización.
Cuerpo de la solicitud: SwitchPoolQuery
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| pool_id | integer (int32) | Sí | Identificador del Pool, no negativo |
Ejemplo de cuerpo de solicitud:
{
"pool_id": 1
}
Respuesta 200 (OK): cuerpo ausente (Pool was switched successfully).
Actualización de la configuración de throttling. Requiere autorización.
Respuesta 200 (OK): SaveConfigResult
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| restart_required | boolean | Sí | Se requiere reiniciar el miner para aplicar la configuración |
| reboot_required | boolean | Sí | Se requiere reiniciar el miner para aplicar |
Cuerpo de la solicitud: ThrottleSettings
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| percent | integer (int32) | Sí | Porcentaje de throttling, de 20 a 100 |
Obtención de información sobre el modelo del miner (algoritmo, serie, plataforma, topología de Hashboards, refrigeración, Overclocking). No requiere autorización.
Respuesta 200 (OK): MinerModelInfo
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| full_name | string | Sí | Nombre visible del miner |
| model | string | Sí | Código del modelo del miner |
| algorithm | string (enum) | Sí | Algoritmo. Valores: sha256d, scrypt |
| series | string (enum) | Sí | Serie. Valores: l7, l9, x19, x21 |
| platform | string (enum) | Sí | Plataforma. Valores: aml, bb, cv, stm, xil |
| install_type | string (enum) | Sí | Tipo de instalación. Valores: sd, nand |
| hr_measure | string (enum) | Sí | Unidad de Hashrate. Valores: GH/s, MH/s |
| serial | string | Sí | Número de serie |
| chain | object (ModelInfoBoard) | Sí | Parámetros de la Hashboard: chips_per_chain, chips_per_domain, num_chains, topology |
| cooling | object (CoolingConsts) | Sí | Constantes de refrigeración: min_fan_pwm, min_target_temp, max_target_temp, fan_min_count |
| overclock | object (Overclock) | Sí | Límites de Overclocking (voltaje, frecuencia, límite de potencia, etc.) |
Objeto anidado chain (ModelInfoBoard):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
chips_per_chain | integer | Sí | Cantidad de chips en una Hashboard. |
chips_per_domain | integer | Sí | Cantidad de chips en un dominio de alimentación. |
num_chains | integer | Sí | Cantidad de Hashboards. |
topology | object (Topology) | Sí | Esquema de disposición de los chips en la Hashboard. |
Objeto anidado en chain topology(Topology):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
chips | array | Sí | Array bidimensional que describe el esquema de disposición de los chips en la Hashboard. Cada elemento contiene identificadores de chips de acuerdo con su ubicación física. |
num_cols | integer | Sí | Cantidad de columnas en el esquema de disposición de los chips. |
num_rows | integer | Sí | Cantidad de filas en el esquema de disposición de los chips. |
Objeto anidado cooling (CoolingConsts):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
min_fan_pwm | integer | Sí | Velocidad mínima permitida de los ventiladores (PWM, %). |
min_target_temp | integer | Sí | Temperatura objetivo mínima permitida de los chips. |
max_target_temp | integer | Sí | Temperatura objetivo máxima permitida de los chips. |
fan_min_count | object (MinerFanMinCount) | null | Sí | Cantidad mínima de ventiladores necesaria para el funcionamiento del dispositivo. Para modelos sin ventiladores, el valor puede ser null. |
Objeto anidado en cooling fan_min_count ( MinerFanMinCount ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| min | integer (int32) | Sí | Cantidad mínima de ventiladores, no negativa |
| max | integer (int32) | Sí | Cantidad máxima de ventiladores, no negativa |
| default | integer (int32) | Sí | Valor por defecto, no negativo |
Objeto anidado overclock (Overclock):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
min_voltage | integer | Sí | Voltaje mínimo. |
default_voltage | integer | Sí | Voltaje por defecto. |
max_voltage | integer | Sí | Voltaje máximo. |
max_voltage_stock_psu | integer | Sí | Voltaje máximo al usar la PSU de stock. |
min_freq | integer | Sí | Frecuencia mínima. |
default_freq | integer | Sí | Frecuencia por defecto. |
warn_freq | integer | Sí | Frecuencia, al excederla se muestra una advertencia. |
max_freq | integer | Sí | Frecuencia máxima. |
max_power_limit | integer | Sí | Límite de potencia máximo permitido. |
power_metering | boolean | Sí | Soporte para la medición del consumo de energía. |
Lectura de todas las notas en forma de diccionario «clave — valor».
Respuesta 200 (OK): objeto (diccionario)
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| (clave arbitraria) | string | — | Valor de la nota; las claves son cadenas arbitrarias |
Cuerpo de la solicitud: NoteKeyValue
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| key | string | Sí | Clave de la nota |
| value | string | Sí | Valor de la nota |
Ejemplo de cuerpo de solicitud:
{
"key": "pool_reminder",
"value": "string1"
}
Respuesta 200 (OK): cuerpo ausente (Note add successfully).
Obtención de una nota por clave.
Parámetro de ruta:
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| note | string | Sí | Clave de la nota |
Ejemplo de solicitud: GET {{baseUrl}}/notes/pool_reminder
Respuesta 200 (OK): NoteValue
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| value | string | Sí | Valor de la nota |
Actualización de una nota por clave. Requiere autorización.
Parámetro de ruta:
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| note | string | Sí | Clave de la nota |
Cuerpo de la solicitud: NoteValue
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| value | string | Sí | Valor de la nota |
Ejemplo de solicitud: PUT {{baseUrl}}/notes/pool_reminder con cuerpo:
{
"value": "string1111"
}
Respuesta 200 (OK): cuerpo ausente (Notes add successfully).
Eliminación de una nota por clave. Requiere autorización.
Parámetro de ruta:
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| note | string | Sí | Clave de la nota |
Respuesta 200 (OK): cuerpo ausente (Note delete successfully).
Resumen de rendimiento: Preset actual y configuración del conmutador de Presets.
Respuesta 200 (OK): PerfSummary
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| preset_switcher | object (PresetSwitcherRaw) | Sí | Configuración del conmutador de Presets (ver abajo) |
| current_preset | object (CurrentPreset) | null | No | Preset actual (name, pretty, status, globals) |
Objeto anidado PresetSwitcherRaw :
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| enabled | boolean | null | No | ¿Está habilitado el conmutador? |
| autochange_top_preset | boolean | null | No | Cambio automático del Preset superior |
| check_time | integer (int32) | null | No | Período de verificación (seg), 60–600 |
| decrease_temp | integer (int32) | null | No | Temperatura de disminución, 25–90 |
| rise_temp | integer (int32) | null | No | Temperatura de aumento, máx. 85 |
| ignore_fan_speed | boolean | null | No | Ignorar velocidad de los ventiladores |
| min_preset | string | null | No | Preset mínimo |
| top_preset | string | null | No | Preset máximo al que puede cambiar |
Objeto anidado current_preset ( CurrentPreset ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| name | string | Sí | Identificador (id) del Preset |
| pretty | string | Sí | Nombre legible del Preset |
| status | string (enum) | Sí | Estado del Preset. Valores: untuned, tuned |
| globals | object (GlobalsRaw) | null | No | Frecuencia/voltaje globales (freq, volt) — presente solo cuando el conmutador de Presets está deshabilitado |
Obtención de todas las configuraciones del miner. Requiere autorización (apikeyAuth).
Respuesta 200 (OK): ViewConfig
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| miner | object (MinerConfigRaw) | Sí | Configuración del miner: cooling, misc, overclock, pools |
| ui | object (UiSettings) | Sí | Configuración de la interfaz (tema, idioma, zona horaria, etc.) |
| regional | object (RegionalSettings) | Sí | Configuración regional: timezone.current |
| network | object (NetworkConfFile) | Sí | Configuración de red: hostname, dhcp, ipaddress, netmask, gateway, dnsservers |
| password | object (PasswordChange) | null | No | Cambio de contraseña: current, pw |
Objeto anidado ui ( UiSettings ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| theme | string (enum) | null | No | Tema. Valores: light, dark, auto |
| locale | string (enum) | null | No | Idioma. Valores: ru, en, fa, ua, zh, pt, ka |
| timezone | string (enum) | null | No | Zona horaria. Valores: GMT+1…GMT+12, GMT, GMT-1…GMT-11 |
| dark_side_pane | boolean | null | No | Panel lateral oscuro |
| disable_animation | boolean | null | No | Desactivación de animación |
| consts | object (Consts) | null | No | Constantes para la interfaz — ver detalles abajo |
Objeto anidado en ui.consts ( Consts ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| cooling | object (CoolingConsts) | Sí | Los mismos campos ya detallados en la sección 6.5.28 (GET /model): min_fan_pwm, min_target_temp, max_target_temp, fan_min_count |
| overclock | object (Overclock) | Sí | Los mismos campos ya detallados en la sección 6.5.28 (GET /model) |
| timezones | array | No | Lista de zonas horarias disponibles para mostrar en la UI, pares «código → nombre» |
Objeto anidado regional ( RegionalSettings ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| timezone | object (TimezoneSettings) | Sí | Envoltura sobre la zona horaria — el único campo current (enum, los mismos valores GMT±N) |
Objeto anidado network ( NetworkConfFile ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| hostname | string | Sí | Nombre de host del dispositivo |
| dhcp | boolean | Sí | ¿Se obtuvo la dirección por DHCP? |
| ipaddress | string | Sí | Dirección IP |
| netmask | string | Sí | Máscara de subred |
| gateway | string | Sí | Dirección de la puerta de enlace |
| dnsservers | array of string | Sí | Lista de servidores DNS |
Objeto anidado password ( PasswordChange ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| current | string | Sí | Contraseña actual |
| pw | string | Sí | Nueva contraseña |
Objeto anidado en ViewConfig miner ( MinerConfigRaw ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| cooling | object (CoolingSettingsRaw) | null | No | Configuración de refrigeración — ver detalles abajo |
| misc | object (AdvancedSettingsRaw) | null | No | Configuración avanzada — ver detalles abajo |
| overclock | object (OverclockSettingsRaw) | null | No | Configuración de Overclocking — ver detalles abajo |
| pools | array | null | No | Lista de 3 Pools (trío fijo) — ver detalles abajo |
Objeto anidado en miner cooling ( CoolingSettingsRaw ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| fan_max_duty | integer (int32) | null | No | Velocidad máxima de los ventiladores, 0–100 |
| fan_min_duty | integer (int32) | null | No | Velocidad mínima de los ventiladores, 0–100 |
| fan_min_count | integer (int32) | null | No | Cantidad mínima de ventiladores, no negativa |
| min_startup_water_temp | integer (int32) | null | No | Temperatura mínima del agua al inicio, 0–20 |
| mode | object (ModeRaw) | null | No | Modo de funcionamiento de los ventiladores — ver detalles abajo |
Objeto anidado en cooling mode ( ModeRaw ) — una de tres opciones (por valor de name):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| name | string (enum) | Sí | Opción de modo. Valores: auto, manual, immers |
| param | integer (int32) | Sí (solo para auto/manual) | Parámetro del modo, no negativo. Ausente cuando name: "immers" |
Objeto anidado en miner misc (AdvancedSettingsRaw) — todos los campos son opcionales (null, si no están definidos):
| Parámetro | Tipo de datos | Descripción |
|---|---|---|
| allow_disabling_chains_without_pics | boolean | null | Permitir la desactivación de Hashboards sin Controladores PIC |
| auto_chip_throttling | boolean | null | Regulación automática de la frecuencia de los chips por temperatura |
| automatic_pause_on_boot | boolean | null | Auto-pausa de la minería inmediatamente después del arranque |
| bitmain_disable_volt_comp | boolean | null | Desactivar compensación de voltaje |
| disable_chain_break_protection | boolean | null | Desactivar protección contra rotura de Hashboard |
| disable_restart_unbalanced | boolean | null | Desactivar reinicio por desequilibrio |
| disable_volt_checks | boolean | null | Desactivar verificaciones de voltaje |
| downscale_preset_on_failure | boolean | null | Auto-reducción del Preset en caso de sobrecalentamiento/error de Hashboard |
| ignore_broken_sensors | boolean | null | Ignorar sensores defectuosos |
| ignore_chip_sensors | boolean | null | Ignorar sensores de chips |
| keep_hashing_when_offline | boolean | null | Continuar minando sin conexión a la red |
| max_restart_attempts | integer (int32) | null | Número máximo de intentos de reinicio, no negativo |
| max_startup_delay_time | integer (int32) | null | Retraso máximo de inicio de minería, 0–300 seg |
| min_startup_delay_time | integer (int32) | null | Retraso mínimo de inicio de minería, 0–300 seg |
| min_operational_chains | integer (int32) | null | Número mínimo de Hashboards operativas, no negativo |
| power_limit | integer (int32) | null | Límite de potencia, no negativo |
| power_limit_enabled | boolean | null | ¿Está habilitado el límite de potencia? |
| quick_start | boolean | null | Inicio rápido |
| quiet_mode | boolean | null | Modo silencioso |
| restart_hashrate | integer (int32) | null | Umbral de Hashrate para reinicio, en porcentaje, 0–100 (0 — deshabilitado) |
| restart_temp | integer (int32) | null | Temperatura para reinicio, 50–120 |
| restore_miner_state_on_reboot | boolean | null | Restaurar el estado del miner después de reiniciar/apagar |
| retune_on_chain_break | boolean | null | Auto-tuning en caso de rotura de Hashboard |
| tuner_bad_chip_hr_threshold | integer (int32) | null | Umbral de Hashrate para marcar un chip como «malo» en Auto-tune, 20–80 |
Objeto anidado en miner overclock ( OverclockSettingsRaw ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| preset | string | null | No | Nombre del perfil de Overclocking actual |
| globals | object (GlobalsRaw) | null | No | Frecuencia/voltaje globales — ver detalles abajo |
| chains | array (BoardRaw) | null | No | Configuración de Overclocking por Hashboards — ver detalles abajo |
| preset_switcher | object (PresetSwitcherRaw) | null | No | Configuración de cambio automático de Presets — los mismos campos que en la sección 6.5.35 (GET /perf-summary) |
Objeto anidado en overclock globals ( GlobalsRaw ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| freq | integer (int32) | null | No | Frecuencia global, no negativa |
| volt | integer (int32) | null | No | Voltaje global, no negativo |
Objeto anidado en overclock chains[] ( BoardRaw ) — un elemento del array por cada Hashboard:
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| freq | integer (int32) | null | No | Frecuencia de la Hashboard. 0 significa «usar el valor de globals» |
| chips | array of integer (int32) | null | No | Frecuencias por cada chip de la Hashboard. 0 en el elemento — usar la frecuencia de la Hashboard |
| disabled | boolean | null | No | Hashboard deshabilitada |
Guardar las configuraciones del miner. Requiere autorización.
Respuesta 200 (OK): SaveConfigResult
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| restart_required | boolean | Sí | Se requiere reiniciar el miner para aplicar la configuración |
| reboot_required | boolean | Sí | Se requiere reiniciar el miner para aplicar |
Cuerpo de la solicitud: InputConfig (todos los campos son opcionales, nullable)
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| miner | object (MinerConfigRaw) | null | No | Configuración del miner |
| network | object (InputNetworkConfFile) | null | No | Red + enable_network_check |
| password | object (PasswordChange) | null | No | Cambio de contraseña |
| regional | object (RegionalSettings) | null | No | Configuración regional |
| ui | object (UiSettings) | null | No | Configuración de la interfaz |
Objeto anidado network ( InputNetworkConfFile ) — es NetworkConfFile más un campo adicional:
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| hostname | string | Sí | Nombre de host del dispositivo |
| dhcp | boolean | Sí | ¿Obtener la dirección por DHCP? |
| ipaddress | string | Sí | Dirección IP |
| netmask | string | Sí | Máscara de subred |
| gateway | string | Sí | Dirección de la puerta de enlace |
| dnsservers | array of string | Sí | Lista de servidores DNS |
| enable_network_check | boolean | No | Habilitar verificación de conexión de red (campo presente solo en InputNetworkConfFile, ausente en NetworkConfFile normal) |
Objeto anidado password ( PasswordChange ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| current | string | Sí | Contraseña actual |
| pw | string | Sí | Nueva contraseña |
Objeto anidado regional ( RegionalSettings ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| timezone | object (TimezoneSettings) | Sí | Envoltura sobre la zona horaria |
Objeto anidado en regional.timezone ( TimezoneSettings ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| current | string (enum) | Sí | Zona horaria. Valores: GMT+1…GMT+12, GMT, GMT-1…GMT-11 |
Objeto anidado ui ( UiSettings ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| theme | string (enum) | null | No | Tema. Valores: light, dark, auto |
| locale | string (enum) | null | No | Idioma. Valores: ru, en, fa, ua, zh, pt, ka |
| timezone | string (enum) | null | No | Zona horaria. Valores: GMT+1…GMT+12, GMT, GMT-1…GMT-11 |
| dark_side_pane | boolean | null | No | Panel lateral oscuro |
| disable_animation | boolean | null | No | Desactivación de animación |
| consts | object (Consts) | null | No | Constantes para mostrar en la UI (solo lectura por significado, normalmente no se transmiten al guardar) — ver detalles abajo |
Objeto anidado en ui.consts ( Consts ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| cooling | object (CoolingConsts) | Sí | Los mismos campos ya detallados en la sección 6.5.28 (GET /model): min_fan_pwm, min_target_temp, max_target_temp, fan_min_count |
| overclock | object (Overclock) | Sí | Los mismos campos ya detallados en la sección 6.5.28 (GET /model) |
| timezones | array | No | Lista de zonas horarias disponibles para mostrar en la UI, pares «código → nombre». Relevante solo para solicitudes GET, para solicitudes UPDATE se puede ignorar |
Copia de seguridad de las configuraciones. Requiere autorización. Devuelve un archivo binario.
Respuesta 200 (OK): datos binarios (application/octet-stream, array de bytes). El servidor devuelve un archivo ( .tar.gz ) que, al descomprimirse, contiene un conjunto de archivos de configuración del miner.
Contenido real del archivo (ejemplo):
| Archivo | Tipo | Contenido |
|---|---|---|
system.conf | CONF | Configuración del sistema |
password | — | Contraseña del dispositivo |
network.conf | CONF | Configuración de red — corresponde a NetworkConfFile (hostname, dhcp, ipaddress, netmask, gateway, dnsservers) |
dashd.conf | CONF | Configuración del servicio del demonio de minería/estado |
cgminer.conf | CONF | Configuración principal de minería: Pools, Overclocking, configuraciones adicionales |
autotune.json | JSON | Presets de Auto-tune guardados — corresponde a los datos de GET /autotune/presets |
apikeys.json | JSON | Lista de API-keys creadas — corresponde a ApiKeysJsonItem (sección 2–4). Array vacío [] si no hay claves |
Restablecimiento de las configuraciones a valores de fábrica. Requiere autorización. Después de la operación, el sistema se reiniciará.
Respuesta 200 (OK): RebootAfter
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| after | integer (int64) | Sí | En cuántos segundos se reiniciará el sistema (por defecto 3) |
Restauración de configuraciones desde un archivo. Requiere autorización. Si la garantía está activa, se devolverá 403 (primero debe cancelar la garantía: /cancel-warranty). Después de la operación, el sistema se reiniciará.
Respuesta 200 (OK): RebootAfter
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| after | integer (int64) | Sí | En cuántos segundos se reiniciará el sistema (por defecto 3) |
Cuerpo de la solicitud: SchemaSettingsRestore (multipart/form-data)
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| file | string (binary) | Sí | Archivo de copia de seguridad de configuraciones |
Obtención del estado del miner (condición, throttling, requisitos de reinicio, localización, garantía). Autorización no especificada.
Respuesta 200 (OK): StatusPane
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| miner_state | string (enum) | Sí | Estado del miner. Valores: mining, initializing, starting, auto-tuning, restarting, shutting-down, stopped, failure |
| throttled | integer (int32) | Sí | Nivel de throttling, 20–100 |
| miner_state_time | integer (int64) | Sí | Tiempo en el estado actual (actualmente implementado para mining) |
| description | string | null | No | Descripción en estado de failure |
| failure_code | integer (int32) | null | No | Código de error |
| restart_required | boolean | Sí | Reinicio requerido |
| reboot_required | boolean | Sí | Reboot requerido |
| find_miner | boolean | Sí | Bandera de la función de localización del miner (por defecto false) |
| unlocked | boolean | Sí | Estado de bloqueo de pantalla (autorización pasada) |
| unlock_timeout | integer (int64) | null | No | Tiempo de espera de desbloqueo |
| warranty | string (enum) | No | Estado de la garantía. Valores: active, inactive, expired, cancelled, not_provided |
Resumen general del miner (estadísticas de Hashrate, temperaturas, potencia, Pools, Hashboards, refrigeración). Requiere autorización.
Respuesta 200 (OK): Summary
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| miner | object (AntmMinerStats) | null | No | Estadísticas del miner (ver campos clave abajo) |
Campos clave de AntmMinerStats :
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| miner_status | object (MinerStatus) | Sí | Estado: miner_state, throttled, miner_state_time |
| miner_type | string | Sí | Tipo de miner |
| hr_stock | number (float) | Sí | Hashrate de stock |
| hr_realtime | number (float) | Sí | Hashrate en tiempo real |
| hr_nominal | number (float) | Sí | Hashrate nominal |
| hr_average | number (float) | Sí | Hashrate promedio |
| average_hashrate | number (float) | Sí | Obsoleto. Lo mismo que hr_average, pero en MH/s |
| instant_hashrate | number (float) | Sí | Obsoleto. Lo mismo que hr_realtime, pero en MH/s |
| pcb_temp | object (TempRange) | Sí | Rango de temperatura de la PCB: min, max |
| chip_temp | object (TempRange) | Sí | Rango de temperatura de los chips: min, max |
| power_consumption | integer (int32) | Sí | Consumo de energía |
| power_efficiency | number (float) | Sí | Eficiencia energética |
| power_usage | integer (int32) | Sí | Obsoleto. Lo mismo que power_efficiency |
| hw_errors | integer (int32) | Sí | Errores de hardware |
| hw_errors_percent | number (float) | Sí | Porcentaje de errores de hardware |
| hr_error | number (float) | Sí | Nivel de errores de Hashrate |
| devfee | number (float) | Sí | DevFee |
| devfee_percent | number (float) | Sí | Porcentaje de DevFee |
| pools | array (PoolStats) | Sí | Estadísticas de Pools (ver abajo) |
| cooling | object (Cooling) | Sí | Refrigeración: fan_num, fans, settings, fan_duty |
| chains | array (AntmBoard) | Sí | Hashboards con estadísticas detalladas |
| found_blocks | integer (int32) | Sí | Bloques encontrados |
| best_share | integer (int64) | Sí | Mejor share |
| restart_count | integer | Sí | Cantidad de reinicios |
| psu | object (AntmPsuInfo) | null | No | Información de la PSU |
Objeto anidado pools[] ( PoolStats ) — un elemento del array por cada Pool:
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| id | integer (int32) | Sí | Identificador del Pool, no negativo |
| url | string | Sí | Dirección del Pool |
| user | string | Sí | Nombre de usuario/Worker |
| pool_type | string (enum) | Sí | Tipo de Pool. Valores: UserPool, DevFee, Refund |
| status | string (enum) | Sí | Estado del Pool. Valores: offline, working, disabled, active, rejecting, unknown |
| diff | string | Sí | Dificultad actual (como cadena, según muestra cgminer) |
| diffa | number (double) | Sí | Dificultad promedio aceptada |
| accepted | integer (int32) | Sí | Cantidad de shares aceptados |
| rejected | integer (int32) | Sí | Cantidad de shares rechazados |
| stale | integer (int32) | Sí | Cantidad de shares obsoletos (stale) |
| ls_diff | number (float) | Sí | Dificultad del último share aceptado |
| ls_time | string | Sí | Hora del último share aceptado |
| ping | integer (int32) | Sí | Ping al Pool, ms |
Objeto anidado cooling ( Cooling ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| fan_num | integer | Sí | Cantidad de ventiladores, no negativa |
| fan_duty | integer (int32) | Sí | Velocidad actual de los ventiladores (duty), total |
| fans | array (Fan) | Sí | Lista de ventiladores — ver detalles abajo |
| settings | object (FanSettings) | Sí | Configuración del modo de ventiladores — ver detalles abajo |
Objeto anidado en cooling fans[] ( Fan ) — un elemento del array por cada ventilador físico:
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| id | integer | Sí | Identificador del ventilador, no negativo |
| rpm | integer (int32) | Sí | RPM actuales |
| max_rpm | integer (int32) | Sí | RPM máximas, no negativas |
| status | string (enum) | Sí | Estado del ventilador. Valores: ok, lost (conexión perdida con el ventilador) |
Objeto anidado en cooling settings ( FanSettings ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| mode | object (FanSettingsMode) | Sí | Modo de funcionamiento de los ventiladores — una de tres opciones por valor de name, ver abajo |
Objeto anidado en settings mode ( FanSettingsMode ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| name | string (enum) | Sí | Opción de modo. Valores: auto, manual, immersion |
| param | integer (int32) | Sí (solo para auto/manual) | Parámetro del modo, no negativo. Ausente cuando name: "immersion" |
Objeto anidado psu ( AntmPsuInfo ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| psu_power_metering | boolean | null | No | Soporte para la medición de potencia por la PSU |
| temps | object (AntmPsuTemps) | null | No | Temperaturas de la PSU — ver detalles abajo |
Objeto anidado en psu temps ( AntmPsuTemps ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| llc1_temp | integer (int32) | null | No | Temperatura de la etapa LLC 1 |
| llc2_temp | integer (int32) | null | No | Temperatura de la etapa LLC 2 |
| pfc_temp | integer (int32) | null | No | Temperatura de la etapa PFC |
Objeto anidado chains[] ( AntmBoard ) — un elemento del array por cada Hashboard:
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| id | integer | Sí | Identificador de la Hashboard, no negativo |
| frequency | number (float) | Sí | Frecuencia de la Hashboard |
| voltage | integer (int32) | Sí | Voltaje de la Hashboard |
| power_consumption | integer (int32) | Sí | Consumo de energía de la Hashboard |
| hashrate_ideal | number (float) | Sí | Hashrate nominal (ideal) de la Hashboard |
| hashrate_rt | number (float) | Sí | Hashrate de la Hashboard en tiempo real |
| hashrate_percentage | number (float) | Sí | Porcentaje del Hashrate nominal |
| hr_error | number (float) | Sí | Nivel de errores de Hashrate de la Hashboard |
| hw_errors | integer (int32) | Sí | Cantidad de errores de hardware de la Hashboard |
| pcb_temp | object (TempRange) | Sí | Rango de temperatura de la PCB de la Hashboard: min, max |
| chip_temp | object (TempRange) | Sí | Rango de temperatura de los chips de la Hashboard: min, max |
| chip_statuses | object (BoardChipStatuses) | Sí | Resumen del estado de los chips de la Hashboard — ver detalles abajo |
| status | object (BoardStatus) | Sí | Estado de la Hashboard — ver detalles abajo |
| inlet_water_temp | integer (int32) | null | No | Temperatura del agua de entrada (para refrigeración líquida), no negativa |
| outlet_water_temp | integer (int32) | null | No | Temperatura del agua de salida (para refrigeración líquida), no negativa |
Objeto anidado en chains[] chip_statuses ( BoardChipStatuses ) — cantidad de chips por categorías:
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| red | integer (int32) | Sí | Cantidad de chips en estado «rojo» (peor estado), no negativa |
| orange | integer (int32) | Sí | Cantidad de chips en estado «naranja» (estado intermedio), no negativa |
| grey | integer (int32) | Sí | Cantidad de chips en estado «gris» (estado normal), no negativa |
Objeto anidado en chains[] status ( BoardStatus ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| state | string (enum) | Sí | Estado de la Hashboard. Valores: initializing, mining, stopped, failure, disconnected, disabled, unknown |
| description | string | null | No | Descripción textual del estado (normalmente se rellena en caso de failure) |
Reinicio del sistema. Requiere autorización.
Respuesta 200 (OK): RebootAfter
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| after | integer (int64) | Sí | En cuántos segundos se reiniciará el sistema (por defecto 3) |
Obtención de la configuración de la interfaz (tema, idioma, zona horaria, constantes de refrigeración/Overclocking, zonas horarias).
Respuesta 200 (OK): UiSettings
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| theme | string (enum) | null | No | Tema. Valores: light, dark, auto |
| locale | string (enum) | null | No | Idioma. Valores: ru, en, fa, ua, zh, pt, ka |
| timezone | string (enum) | null | No | Zona horaria. Valores: GMT+1…GMT+12, GMT, GMT-1…GMT-11 |
| dark_side_pane | boolean | null | No | Panel lateral oscuro |
| disable_animation | boolean | null | No | Desactivación de animación |
| consts | object (Consts) | null | No | Constantes: cooling, overclock, timezones |
Objeto anidado en UiSettings ( Consts ):
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| cooling | object (CoolingConsts) | Sí | Los mismos campos ya detallados en la sección 6.5.28 (GET /model): min_fan_pwm, min_target_temp, max_target_temp, fan_min_count |
| overclock | object (Overclock) | Sí | Los mismos campos ya detallados en la sección 6.5.28 (GET /model) |
| timezones | array | No | Lista de zonas horarias disponibles para mostrar en la UI, pares «código → nombre» |
Desbloqueo (autenticación por contraseña). Devuelve un token JWT.
Respuesta 200 (OK): UnlockSuccess
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| token | string | Sí | Token JWT de autorización |
Cuerpo de la solicitud: UnlockScreenBody
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| pw | string | Sí | Contraseña del dispositivo (o dispositivos) de destino |
⚠️ El endpoint ya no se utiliza. Está marcado como
deprecateden la especificación y se conserva solo por compatibilidad con clientes antiguos. Para nuevas integraciones, utilice el actualPOST /locate-miner(sección 6.5.15).
ErrDescr (utilizado en respuestas 400, 409, 500, 507 y otros)
| Parámetro | Tipo de datos | Obligatorio | Descripción |
|---|---|---|---|
| err | string | Sí | Texto del error |