Referência de Endpoints
Ativação da garantia do minerador. Requer autorização. Retorna o status da garantia.
Resposta 200: WarrantyStatus Resposta 200 (OK): array ApiKeysJsonItem
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| success | boolean | Sim | Indicador de sucesso da operação |
| warranty | string (enum) | Não | Status da garantia. Valores: active — ativa; inactive — inativa; expired — expirada; cancelled — cancelada; not_provided — não fornecida |
Obtenção da lista de API-keys. Requer autorização. Retorna um array de chaves.
Resposta 200 (OK): array ApiKeysJsonItem
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| key | string | Sim | API-key com exatamente 32 caracteres |
| description | string | Sim | Descrição da chave |
Adição de uma nova API-key. Requer autorização. O corpo da requisição transmite a chave e a descrição (AddApikeyQuery = ApiKeysJsonItem).
Resposta 200 (OK): AddApiKeyRes
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| status | string (enum) | Sim | Resultado da operação. Valores: inserted — chave adicionada; updated — chave atualizada; nochanges — sem alterações |
Exclusão de API-key. Requer autorização. O corpo da requisição transmite a chave (DeleteApikeyQuery).
Resposta 200 (OK): corpo ausente (Key deleted successfully).
Verificação de autorização. Retorna informações sobre o timeout até o fim do bloqueio temporário do dispositivo.
Resposta 200 (OK): AuthCheck
Se o dispositivo não estiver em bloqueio temporário, um objeto vazio é retornado:
{}
Se o dispositivo estiver em bloqueio temporário, a resposta contém o campo unlock_timeout, que indica o número de segundos restantes até o fim do bloqueio:
{
"unlock_timeout":58
}
Nota: a ausência do campo
unlock_timeouté equivalente ao valornulle significa que não há bloqueio temporário.
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| unlock_timeout | integer (int64) | null | Não | Timeout de bloqueio (segundos), valor não negativo |
Obtenção da lista de Presets de Auto-tune. Requer autorização. Retorna um array de Presets com configurações de tuning.
Resposta 200 (OK): array AutotunePresetDto
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| name | string | Sim | Identificador (id) do Preset |
| pretty | string | Sim | Nome legível do Preset |
| status | string (enum) | Sim | Status do Preset. Valores: untuned — não configurado; tuned — configurado com sucesso |
| tune_settings | object (AutotuneResultsItem) | null | Não | Resultados do tuning (ver abaixo) |
Objeto aninhado tune_settings ( AutotuneResultsItem ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| hashrate | integer (int32) | Sim | Hashrate, não negativo |
| volt | integer (int32) | Sim | Tensão, não negativa |
| freq | integer (int32) | Sim | Frequência, não negativa |
| chains | array (AutotuneBoard) | Sim | Lista de Hashboards: freq (int32), chips (array int32), serial (string | null) |
| modified | boolean | Sim | Indicador de modificação manual |
| date | string | null | Não | Data do tuning |
Redefinição da lista especificada de perfis de Auto-tune. Requer autorização.
Resposta 200 (OK): corpo ausente.
Corpo da requisição: AutotuneReset
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| presets | array of string | Sim | Lista de Presets para redefinição |
| restart | boolean | Sim | Reiniciar após a exclusão dos Presets |
Redefinição de todos os perfis de Auto-tune. Requer autorização.
Resposta 200 (OK): corpo ausente.
Corpo da requisição: AutotuneResetAll
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| restart | boolean | Sim | Reiniciar após a redefinição |
Obtenção das Hashboards do minerador com detalhamento por chips e sensores. Autorização não é necessária.
Resposta 200 (OK): array AntmBoardChips
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| id | integer | Sim | Identificador da Hashboard, não negativo |
| status | object (CgBoardStatus) | Sim | Status da Hashboard: state (enum), failure_message (string | null) |
| hr_realtime | number (float) | Sim | Hashrate em tempo real |
| hr_nominal | number (float) | Sim | Hashrate nominal |
| freq | number (float) | Sim | Frequência |
| sensors | array (AntmChipSensor) | Sim | Sensores: state, board, chip, loc |
| chips | array (AntmChip) | Sim | Chips (ver abaixo) |
Objeto aninhado status ( CgBoardStatus ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| state | string (enum) | Sim | Estado da Hashboard. Valores: initializing, mining, stopped, failure, disconnected, disabled, unknown |
| failure_message | string | null | Não | Descrição textual do erro (geralmente preenchida em caso de failure) |
Objeto aninhado sensors[] ( AntmChipSensor ) — um elemento do array para cada sensor:
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| state | string (enum) | Sim | Status do sensor. Valores: init, ready, measure, error, unknown |
| board | integer (int32) | Sim | Número da Hashboard à qual o sensor pertence |
| chip | integer (int32) | Sim | Número do chip ao qual o sensor pertence |
| loc | integer (int32) | Sim | Localização do sensor — refere-se a chip.id, não negativo |
Objeto aninhado do chip AntmChip :
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| id | integer | Sim | Identificador do chip |
| hr | number (float) | Sim | Hashrate |
| freq | integer (int32) | Sim | Frequência |
| volt | integer (int32) | Sim | Tensão |
| temp | number (float) | Sim | Temperatura |
| errs | integer (int32) | Sim | Número de erros |
| grade | string (enum) | Sim | Classificação do chip. Valores: grey, orange, red |
| throttled | boolean | Sim | Indicador de Throttling |
Cancelamento da garantia do minerador. Requer autorização.
Resposta 200 (OK): WarrantyStatus
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| success | boolean | Sim | Indicador de sucesso da operação |
| warranty | string (enum) | Não | Status da garantia. Valores: active, inactive, expired, cancelled, not_provided |
Obtenção de informações de fábrica sobre as Hashboards do minerador. Autorização não é necessária.
Resposta 200 (OK): FactoryInfoReply
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| chains | array (FactoryInfoBoard) | null | Não | Lista de Hashboards com dados de fábrica |
| has_pics | boolean | null | Não | Presença de Control Boards PIC |
| hr_stock | number (double) | null | Não | Hashrate de fábrica |
| psu_model | string | null | Não | Modelo da PSU |
| psu_serial | string | null | Não | Número de série da PSU |
Objeto aninhado: FactoryInfoBoard
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| id | integer (int32) | Sim | Identificador da Hashboard |
| board_model | string | Sim | Modelo da Hashboard |
| serial | string | Sim | Número de série |
| chip_bin | integer (int32) | Sim | Bin dos chips |
| freq | integer (int32) | Sim | Frequência |
| volt | integer (int32) | Sim | Tensão |
| hashrate | number (double) | Sim | Hashrate |
Remoção de Firmware e carregamento do Firmware de fábrica. Requer autorização. Após a operação, o sistema será reiniciado.
Resposta 200 (OK): RebootAfter
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| after | integer (int64) | Sim | Em quantos segundos o sistema será reiniciado (padrão 3), não negativo |
Corpo da requisição: FwRemoveParams
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| remove_stock_logs | boolean | Sim | Remover logs de fábrica |
Atualização de Firmware. Requer autorização. Após a atualização, o sistema será reiniciado.
Resposta 200: RebootAfter
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| after | integer (int64) | Sim | Em quantos segundos o sistema será reiniciado (padrão 3) |
Corpo da requisição: SchemaFirmwareUpdate (multipart/form-data)
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| file | string (binary) | Sim | Arquivo de Firmware |
| keep_settings | string (enum) | null | Não | Manter configurações. Valores: true, false |
Obtenção de informações gerais sobre o minerador (dados de Firmware + modelo, algoritmo, sistema). Autorização não é necessária.
Resposta 200 (OK): InfoJson
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| fw_name | string | Sim | Nome do Firmware |
| fw_version | string | Sim | Versão do Firmware |
| platform | string (enum) | Sim | Plataforma. Valores: aml (Amlogic), bb (BeagleBone), cv (Cvitek), stm (STM), xil (Xilinx) |
| install_type | string (enum) | Sim | Tipo de instalação. Valores: sd, nand |
| build_time | string | Sim | Tempo de compilação |
| build_name | string | Não | Nome da compilação |
| build_uuid | string | Não | UUID da compilação |
| miner | string | Sim | Nome de exibição do minerador |
| model | string | Sim | Código do modelo do minerador |
| algorithm | string (enum) | Sim | Algoritmo de mineração. Valores: sha256d, scrypt, unknown |
| hr_measure | string (enum) | Sim | Unidade de medida de Hashrate. Valores: GH/s, MH/s, N/A |
| serial | string | Sim | Número de série |
| system | object (SystemInfo) | Sim | Informações do sistema (memória, SO, rede, uptime, etc.) ver detalhamento abaixo |
Objeto aninhado system ( SystemInfo ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| mem_total | integer (int32) | Sim | Volume total de memória, não negativo |
| mem_free | integer (int32) | Sim | Memória livre, não negativa |
| mem_free_percent | integer (int32) | Sim | Porcentagem de memória livre, não negativa |
| mem_buf | integer (int32) | Sim | Memória ocupada por buffers, não negativa |
| mem_buf_percent | integer (int32) | Sim | Porcentagem de memória para buffers, não negativa |
| os | string | Sim | Nome do sistema operacional |
| miner_name | string | Sim | Nome do minerador no sistema |
| file_system_version | string | Sim | Versão do sistema de arquivos |
| uptime | string | Sim | Tempo de atividade do sistema sem reinicialização |
| network_status | object (NetworkStatus) | Sim | Status da rede — ver detalhamento abaixo |
Objeto aninhado network_status (NetworkStatus):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| mac | string | Sim | Endereço MAC da interface de rede |
| ip | string | Sim | Endereço IP atual |
| netmask | string | Sim | Máscara de sub-rede |
| gateway | string | Sim | Endereço do gateway |
| dns | array of string | Sim | Lista de servidores DNS |
| hostname | string | Sim | Nome do host do dispositivo |
| dhcp | boolean | null | Não | Endereço obtido via DHCP |
Localização (iluminação/busca) do minerador. Retorna o estado atual da função. Autorização não é necessária.
Resposta 200 (OK): LocateMinerStatus
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| is_enabled | boolean | Sim | Ativação/desativação da função de localização do minerador |
Bloqueio do minerador (redefinição da sessão atual). Requer autorização (bearerAuth).
Resposta 200 (OK): corpo ausente.
Bloqueio de outras sessões do minerador, exceto a atual. Requer autorização (bearerAuth).
Resposta 200 (OK): corpo ausente.
Corpo da requisição: UnlockScreenBody
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| pw | string | Sim | Senha do dispositivo(s) alvo |
Leitura de arquivo de log por tipo. O tipo * (todos os logs) não está implementado para esta rota. Autorização não é necessária.
Parâmetro de caminho:
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| log_type | string (enum) | Sim | Tipo de log. Valores: status, miner, autotune, pool, hwscan, system, messages, api, * (todos — não implementado para esta rota). Os valores são especificados em letras minúsculas. |
⚠️Na prática, os realmente utilizados são:
status,miner,hwscan,autotune,system. Os valores são especificados em letras minúsculas.
Resposta 200 (OK): arquivo de log (corpo sem esquema descrito).
Limpeza de logs do tipo especificado. Requer autorização.
Parâmetro de caminho:
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| log_type | string (enum) | Sim | Tipo de log. Valores: status, miner, autotune, pool, hwscan, system, messages, api, * |
⚠️ Na prática, os realmente utilizados são:
status,miner,hwscan,autotune. Os valores são especificados em letras minúsculas.
Resposta 200 (OK): corpo ausente (Logs was cleared successfully).
Obtenção de métricas do minerador para um intervalo de tempo com média por passo.
Parâmetros de requisição (query):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| time_slice | integer (int32) | Não | Número de segundos até o momento atual. Máx. 3 dias (259200), padrão 1 dia (86400) |
| step | integer (int32) | Não | Passo de reamostragem (segundos) para a média, padrão 15 min (900) |
Resposta 200 (OK): MetricsReply
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| timezone | string (enum) | Sim | Fuso horário. Valores: GMT+1…GMT+12, GMT, GMT-1…GMT-11 |
| metrics | array (TimeRecord_MetricsData) | Sim | Registros de métricas com tempo (ver abaixo) |
| annotations | array (TimeRecord_MetricAnnotation) | Sim | Anotações de eventos com tempo |
Aninhado metrics[].data ( MetricsData ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| time | integer (int64) | Sim | Tempo UNIX do registro |
| hashrate | number (double) | Sim | Hashrate |
| pcb_max_temp | integer (int32) | Sim | Temperatura máxima da PCB |
| chip_max_temp | integer (int32) | Sim | Temperatura máxima do chip |
| fan_duty | integer (int32) | Sim | Velocidade dos ventiladores (duty) |
| power_consumption | integer (int32) | Sim | Consumo de energia |
Aninhado annotations[].data ( MetricAnnotation ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| time | integer (int64) | Sim | Tempo UNIX do evento |
| type | string (enum) | Sim | Tipo de evento. Valores: start, stop, restart, reboot, overheat, disable_board, enable_board, fw_update |
| board_id | integer (int32) | null | Não | Identificador da Hashboard |
Pausar mineração. Requer autorização.
Resposta 200 (OK): corpo ausente (Mining paused).
Reiniciar mineração. Requer autorização.
Resposta 200 (OK): corpo ausente (Mining restart).
Retomar mineração. Requer autorização.
Resposta 200 (OK): corpo ausente (Mining resumed).
Iniciar mineração. Requer autorização.
Resposta 200 (OK): corpo ausente (Mining started).
Parar mineração. Requer autorização.
Resposta 200 (OK): corpo ausente (Mining stopped).
Trocar o Pool ativo. Requer autorização.
Corpo da requisição: SwitchPoolQuery
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| pool_id | integer (int32) | Sim | Identificador do Pool, não negativo |
Exemplo de corpo da requisição:
{
"pool_id": 1
}
Resposta 200 (OK): corpo ausente (Pool was switched successfully).
Atualização das configurações de Throttling. Requer autorização.
Resposta 200 (OK): SaveConfigResult
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| restart_required | boolean | Sim | Reinicialização do minerador necessária para aplicar a configuração |
| reboot_required | boolean | Sim | Reinicialização do minerador necessária para aplicar |
Corpo da requisição: ThrottleSettings
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| percent | integer (int32) | Sim | Porcentagem de Throttling, de 20 a 100 |
Obtenção de informações sobre o modelo do minerador (algoritmo, série, plataforma, topologia das Hashboards, resfriamento, Overclock). Autorização não é necessária.
Resposta 200 (OK): MinerModelInfo
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| full_name | string | Sim | Nome de exibição do minerador |
| model | string | Sim | Código do modelo do minerador |
| algorithm | string (enum) | Sim | Algoritmo. Valores: sha256d, scrypt |
| series | string (enum) | Sim | Série. Valores: l7, l9, x19, x21 |
| platform | string (enum) | Sim | Plataforma. Valores: aml (Amlogic), bb (BeagleBone), cv (Cvitek), stm (STM), xil (Xilinx) |
| install_type | string (enum) | Sim | Tipo de instalação. Valores: sd, nand |
| hr_measure | string (enum) | Sim | Unidade de Hashrate. Valores: GH/s, MH/s |
| serial | string | Sim | Número de série |
| chain | object (ModelInfoBoard) | Sim | Parâmetros da Hashboard: chips_per_chain, chips_per_domain, num_chains, topology |
| cooling | object (CoolingConsts) | Sim | Constantes de resfriamento: min_fan_pwm, min_target_temp, max_target_temp, fan_min_count |
| overclock | object (Overclock) | Sim | Limites de Overclock (tensão, frequência, limite de potência, etc.) |
Objeto aninhado chain (ModelInfoBoard):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
chips_per_chain | integer | Sim | Número de chips em uma Hashboard. |
chips_per_domain | integer | Sim | Número de chips em um domínio de energia. |
num_chains | integer | Sim | Número de Hashboards. |
topology | object (Topology) | Sim | Esquema de layout dos chips na Hashboard. |
Objeto aninhado em chain topology(Topology):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
chips | array | Sim | Array bidimensional que descreve o esquema de layout dos chips na Hashboard. Cada elemento contém identificadores de chips de acordo com sua localização física. |
num_cols | integer | Sim | Número de colunas no esquema de layout dos chips. |
num_rows | integer | Sim | Número de linhas no esquema de layout dos chips. |
Objeto aninhado cooling (CoolingConsts):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
min_fan_pwm | integer | Sim | Velocidade mínima permitida dos ventiladores (PWM, %). |
min_target_temp | integer | Sim | Temperatura alvo mínima permitida dos chips. |
max_target_temp | integer | Sim | Temperatura alvo máxima permitida dos chips. |
fan_min_count | object (MinerFanMinCount) | null | Sim | Número mínimo de ventiladores necessários para o funcionamento do dispositivo. Para modelos sem ventiladores, o valor pode ser null. |
Objeto aninhado em cooling fan_min_count ( MinerFanMinCount ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| min | integer (int32) | Sim | Número mínimo de ventiladores, não negativo |
| max | integer (int32) | Sim | Número máximo de ventiladores, não negativo |
| default | integer (int32) | Sim | Valor padrão, não negativo |
Objeto aninhado overclock (Overclock):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
min_voltage | integer | Sim | Tensão mínima. |
default_voltage | integer | Sim | Tensão padrão. |
max_voltage | integer | Sim | Tensão máxima. |
max_voltage_stock_psu | integer | Sim | Tensão máxima ao usar a PSU padrão. |
min_freq | integer | Sim | Frequência mínima. |
default_freq | integer | Sim | Frequência padrão. |
warn_freq | integer | Sim | Frequência, ao exceder a qual um aviso é exibido. |
max_freq | integer | Sim | Frequência máxima. |
max_power_limit | integer | Sim | Limite máximo de potência permitido. |
power_metering | boolean | Sim | Suporte para medição de consumo de energia. |
Leitura de todas as notas como um dicionário "chave — valor".
Resposta 200 (OK): objeto (dicionário)
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| (chave arbitrária) | string | — | Valor da nota; chaves — strings arbitrárias |
Corpo da requisição: NoteKeyValue
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| key | string | Sim | Chave da nota |
| value | string | Sim | Valor da nota |
Exemplo de corpo da requisição:
{
"key": "pool_reminder",
"value": "string1"
}
Resposta 200 (OK): corpo ausente (Note add successfully).
Obtenção de uma nota por chave.
Parâmetro de caminho:
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| note | string | Sim | Chave da nota |
Exemplo de requisição: GET {{baseUrl}}/notes/pool_reminder
Resposta 200 (OK): NoteValue
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| value | string | Sim | Valor da nota |
Atualização de nota por chave. Requer autorização.
Parâmetro de caminho:
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| note | string | Sim | Chave da nota |
Corpo da requisição: NoteValue
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| value | string | Sim | Valor da nota |
Exemplo de requisição: PUT {{baseUrl}}/notes/pool_reminder com corpo:
{
"value": "string1111"
}
Resposta 200 (OK): corpo ausente (Notes add successfully).
Exclusão de nota por chave. Requer autorização.
Parâmetro de caminho:
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| note | string | Sim | Chave da nota |
Resposta 200 (OK): corpo ausente (Note delete successfully).
Resumo de desempenho: Preset atual e configurações do seletor de Presets.
Resposta 200 (OK): PerfSummary
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| preset_switcher | object (PresetSwitcherRaw) | Sim | Configurações do seletor de Presets (ver abaixo) |
| current_preset | object (CurrentPreset) | null | Não | Preset atual (name, pretty, status, globals) |
Objeto aninhado PresetSwitcherRaw :
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| enabled | boolean | null | Não | Se o seletor está ativado |
| autochange_top_preset | boolean | null | Não | Troca automática do Preset superior |
| check_time | integer (int32) | null | Não | Período de verificação (segundos), 60–600 |
| decrease_temp | integer (int32) | null | Não | Temperatura de diminuição, 25–90 |
| rise_temp | integer (int32) | null | Não | Temperatura de aumento, máx. 85 |
| ignore_fan_speed | boolean | null | Não | Ignorar velocidade dos ventiladores |
| min_preset | string | null | Não | Preset mínimo |
| top_preset | string | null | Não | Preset máximo, até o qual pode alternar |
Objeto aninhado current_preset ( CurrentPreset ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| name | string | Sim | Identificador (id) do Preset |
| pretty | string | Sim | Nome legível do Preset |
| status | string (enum) | Sim | Status do Preset. Valores: untuned, tuned |
| globals | object (GlobalsRaw) | null | Não | Frequência/tensão globais (freq, volt) — presente apenas quando o seletor de Presets está desativado |
Obtenção de todas as configurações do minerador. Requer autorização (apikeyAuth).
Resposta 200 (OK): ViewConfig
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| miner | object (MinerConfigRaw) | Sim | Configurações do minerador: cooling, misc, overclock, pools |
| ui | object (UiSettings) | Sim | Configurações da interface (tema, localidade, fuso horário, etc.) |
| regional | object (RegionalSettings) | Sim | Configurações regionais: timezone.current |
| network | object (NetworkConfFile) | Sim | Configuração de rede: hostname, dhcp, ipaddress, netmask, gateway, dnsservers |
| password | object (PasswordChange) | null | Não | Alteração de senha: current, pw |
Objeto aninhado ui ( UiSettings ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| theme | string (enum) | null | Não | Tema. Valores: light, dark, auto |
| locale | string (enum) | null | Não | Localidade. Valores: ru, en, fa, ua, zh, pt, ka |
| timezone | string (enum) | null | Não | Fuso horário. Valores: GMT+1…GMT+12, GMT, GMT-1…GMT-11 |
| dark_side_pane | boolean | null | Não | Painel lateral escuro |
| disable_animation | boolean | null | Não | Desativação de animação |
| consts | object (Consts) | null | Não | Constantes para a interface — ver detalhamento abaixo |
Objeto aninhado em ui.consts ( Consts ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| cooling | object (CoolingConsts) | Sim | Os mesmos campos já detalhados na seção 6.5.28 (GET /model): min_fan_pwm, min_target_temp, max_target_temp, fan_min_count |
| overclock | object (Overclock) | Sim | Os mesmos campos já detalhados na seção 6.5.28 (GET /model) |
| timezones | array | Não | Lista de fusos horários disponíveis para exibição na UI, pares "código → nome" |
Objeto aninhado regional ( RegionalSettings ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| timezone | object (TimezoneSettings) | Sim | Wrapper sobre o fuso horário — único campo current (enum, os mesmos valores GMT±N) |
Objeto aninhado network ( NetworkConfFile ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| hostname | string | Sim | Nome do host do dispositivo |
| dhcp | boolean | Sim | Endereço obtido via DHCP |
| ipaddress | string | Sim | Endereço IP |
| netmask | string | Sim | Máscara de sub-rede |
| gateway | string | Sim | Endereço do gateway |
| dnsservers | array of string | Sim | Lista de servidores DNS |
Objeto aninhado password ( PasswordChange ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| current | string | Sim | Senha atual |
| pw | string | Sim | Nova senha |
Objeto aninhado em ViewConfig miner ( MinerConfigRaw ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| cooling | object (CoolingSettingsRaw) | null | Não | Configurações de resfriamento — ver detalhamento abaixo |
| misc | object (AdvancedSettingsRaw) | null | Não | Configurações adicionais (avançadas) — ver detalhamento abaixo |
| overclock | object (OverclockSettingsRaw) | null | Não | Configurações de Overclock — ver detalhamento abaixo |
| pools | array | null | Não | Lista de 3 Pools (trio fixo) — ver detalhamento abaixo |
Objeto aninhado em miner cooling ( CoolingSettingsRaw ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| fan_max_duty | integer (int32) | null | Não | Velocidade máxima dos ventiladores, 0–100 |
| fan_min_duty | integer (int32) | null | Não | Velocidade mínima dos ventiladores, 0–100 |
| fan_min_count | integer (int32) | null | Não | Número mínimo de ventiladores, não negativo |
| min_startup_water_temp | integer (int32) | null | Não | Temperatura mínima da água na inicialização, 0–20 |
| mode | object (ModeRaw) | null | Não | Modo de operação dos ventiladores — ver detalhamento abaixo |
Objeto aninhado em cooling mode ( ModeRaw ) — uma das três opções (pelo valor de name):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| name | string (enum) | Sim | Opção de modo. Valores: auto, manual, immers |
| param | integer (int32) | Sim (apenas para auto/manual) | Parâmetro do modo, não negativo. Ausente quando name: "immers" |
Objeto aninhado em miner misc (AdvancedSettingsRaw) — todos os campos são opcionais (null, se não definidos):
| Parâmetro | Tipo de dados | Descrição |
|---|---|---|
| allow_disabling_chains_without_pics | boolean | null | Permitir desativação de Hashboards sem Control Boards PIC |
| auto_chip_throttling | boolean | null | Regulagem automática da frequência dos chips por temperatura |
| automatic_pause_on_boot | boolean | null | Pausa automática da mineração imediatamente após a inicialização |
| bitmain_disable_volt_comp | boolean | null | Desativar compensação de tensão |
| disable_chain_break_protection | boolean | null | Desativar proteção contra quebra de Hashboard |
| disable_restart_unbalanced | boolean | null | Desativar reinicialização em caso de desequilíbrio |
| disable_volt_checks | boolean | null | Desativar verificações de tensão |
| downscale_preset_on_failure | boolean | null | Redução automática do Preset em caso de superaquecimento/erro da Hashboard |
| ignore_broken_sensors | boolean | null | Ignorar sensores defeituosos |
| ignore_chip_sensors | boolean | null | Ignorar sensores de chip |
| keep_hashing_when_offline | boolean | null | Continuar mineração na ausência de rede |
| max_restart_attempts | integer (int32) | null | Número máximo de tentativas de reinicialização, não negativo |
| max_startup_delay_time | integer (int32) | null | Atraso máximo de inicialização da mineração, 0–300 segundos |
| min_startup_delay_time | integer (int32) | null | Atraso mínimo de inicialização da mineração, 0–300 segundos |
| min_operational_chains | integer (int32) | null | Número mínimo de Hashboards operacionais, não negativo |
| power_limit | integer (int32) | null | Limite de potência, não negativo |
| power_limit_enabled | boolean | null | Limite de potência ativado |
| quick_start | boolean | null | Início rápido |
| quiet_mode | boolean | null | Modo silencioso |
| restart_hashrate | integer (int32) | null | Limite de Hashrate para reinicialização, em porcentagem, 0–100 (0 — desativado) |
| restart_temp | integer (int32) | null | Temperatura para reinicialização, 50–120 |
| restore_miner_state_on_reboot | boolean | null | Restaurar estado do minerador após reinicialização/desligamento |
| retune_on_chain_break | boolean | null | Auto-tune em caso de quebra de Hashboard |
| tuner_bad_chip_hr_threshold | integer (int32) | null | Limite de Hashrate para marcar um chip como 'ruim' no Auto-tune, 20–80 |
Objeto aninhado em miner overclock ( OverclockSettingsRaw ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| preset | string | null | Não | Nome do perfil de Overclock atual |
| globals | object (GlobalsRaw) | null | Não | Frequência/tensão globais — ver detalhamento abaixo |
| chains | array (BoardRaw) | null | Não | Configurações de Overclock por Hashboards — ver detalhamento abaixo |
| preset_switcher | object (PresetSwitcherRaw) | null | Não | Configurações de troca automática de Presets — os mesmos campos da seção 6.5.35 (GET /perf-summary) |
Objeto aninhado em overclock globals ( GlobalsRaw ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| freq | integer (int32) | null | Não | Frequência global, não negativa |
| volt | integer (int32) | null | Não | Tensão global, não negativa |
Objeto aninhado em overclock chains[] ( BoardRaw ) — um elemento do array para cada Hashboard:
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| freq | integer (int32) | null | Não | Frequência da Hashboard. 0 significa "usar valor de globals" |
| chips | array of integer (int32) | null | Não | Frequências por cada chip da Hashboard. 0 no elemento — usar frequência da Hashboard |
| disabled | boolean | null | Não | Hashboard desativada |
Salvar configurações do minerador. Requer autorização.
Resposta 200 (OK): SaveConfigResult
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| restart_required | boolean | Sim | Reinicialização do minerador necessária para aplicar a configuração |
| reboot_required | boolean | Sim | Reinicialização do minerador necessária para aplicar |
Corpo da requisição: InputConfig (todos os campos são opcionais, nullable)
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| miner | object (MinerConfigRaw) | null | Não | Configurações do minerador |
| network | object (InputNetworkConfFile) | null | Não | Rede + enable_network_check |
| password | object (PasswordChange) | null | Não | Alteração de senha |
| regional | object (RegionalSettings) | null | Não | Configurações regionais |
| ui | object (UiSettings) | null | Não | Configurações da interface |
Objeto aninhado network ( InputNetworkConfFile ) — é NetworkConfFile mais um campo adicional:
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| hostname | string | Sim | Nome do host do dispositivo |
| dhcp | boolean | Sim | Obter endereço via DHCP |
| ipaddress | string | Sim | Endereço IP |
| netmask | string | Sim | Máscara de sub-rede |
| gateway | string | Sim | Endereço do gateway |
| dnsservers | array of string | Sim | Lista de servidores DNS |
| enable_network_check | boolean | Não | Ativar verificação de conexão de rede (campo presente apenas em InputNetworkConfFile, ausente em NetworkConfFile normal) |
Objeto aninhado password ( PasswordChange ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| current | string | Sim | Senha atual |
| pw | string | Sim | Nova senha |
Objeto aninhado regional ( RegionalSettings ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| timezone | object (TimezoneSettings) | Sim | Wrapper sobre o fuso horário |
Objeto aninhado em regional.timezone ( TimezoneSettings ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| current | string (enum) | Sim | Fuso horário. Valores: GMT+1…GMT+12, GMT, GMT-1…GMT-11 |
Objeto aninhado ui ( UiSettings ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| theme | string (enum) | null | Não | Tema. Valores: light, dark, auto |
| locale | string (enum) | null | Não | Localidade. Valores: ru, en, fa, ua, zh, pt, ka |
| timezone | string (enum) | null | Não | Fuso horário. Valores: GMT+1…GMT+12, GMT, GMT-1…GMT-11 |
| dark_side_pane | boolean | null | Não | Painel lateral escuro |
| disable_animation | boolean | null | Não | Desativação de animação |
| consts | object (Consts) | null | Não | Constantes para exibição na UI (somente leitura por natureza, geralmente não transmitidas ao salvar) — ver detalhamento abaixo |
Objeto aninhado em ui.consts ( Consts ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| cooling | object (CoolingConsts) | Sim | Os mesmos campos já detalhados na seção 6.5.28 (GET /model): min_fan_pwm, min_target_temp, max_target_temp, fan_min_count |
| overclock | object (Overclock) | Sim | Os mesmos campos já detalhados na seção 6.5.28 (GET /model) |
| timezones | array | Não | Lista de fusos horários disponíveis para exibição na UI, pares "código → nome". Relevante apenas para requisições GET, para requisições UPDATE pode ser ignorado |
Backup de configurações. Requer autorização. Retorna um arquivo binário.
Resposta 200 (OK): dados binários (application/octet-stream, array de bytes). O servidor retorna um arquivo ( .tar.gz ) que, ao ser descompactado, contém um conjunto de arquivos de configuração do minerador.
Conteúdo real do arquivo (exemplo):
| Arquivo | Tipo | O que contém |
|---|---|---|
system.conf | CONF | Configurações do sistema |
password | — | Senha do dispositivo |
network.conf | CONF | Configurações de rede — corresponde a NetworkConfFile (hostname, dhcp, ipaddress, netmask, gateway, dnsservers) |
dashd.conf | CONF | Configurações do serviço do daemon de mineração/status |
cgminer.conf | CONF | Configuração principal de mineração: Pools, Overclock, configurações adicionais |
autotune.json | JSON | Presets de Auto-tune salvos — corresponde aos dados de GET /autotune/presets |
apikeys.json | JSON | Lista de API-keys criadas — corresponde a ApiKeysJsonItem (seção 2–4). Array vazio [], se não houver chaves |
Redefinição das configurações para as de fábrica. Requer autorização. Após a operação, o sistema será reiniciado.
Resposta 200 (OK): RebootAfter
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| after | integer (int64) | Sim | Em quantos segundos o sistema será reiniciado (padrão 3) |
Restauração de configurações a partir de um arquivo. Requer autorização. Se a garantia estiver ativa, retornará 403 (é necessário cancelar a garantia primeiro: /cancel-warranty). Após a operação, o sistema será reiniciado.
Resposta 200 (OK): RebootAfter
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| after | integer (int64) | Sim | Em quantos segundos o sistema será reiniciado (padrão 3) |
Corpo da requisição: SchemaSettingsRestore (multipart/form-data)
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| file | string (binary) | Sim | Arquivo de backup das configurações |
Obtenção do status do minerador (estado, Throttling, requisitos de reinicialização, localização, garantia). Autorização não especificada.
Resposta 200 (OK): StatusPane
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| miner_state | string (enum) | Sim | Estado do minerador. Valores: mining, initializing, starting, auto-tuning, restarting, shutting-down, stopped, failure |
| throttled | integer (int32) | Sim | Nível de Throttling, 20–100 |
| miner_state_time | integer (int64) | Sim | Tempo no estado atual (atualmente implementado para mining) |
| description | string | null | Não | Descrição em caso de status failure |
| failure_code | integer (int32) | null | Não | Código de erro |
| restart_required | boolean | Sim | Reinicialização necessária |
| reboot_required | boolean | Sim | Reinicialização do sistema necessária |
| find_miner | boolean | Sim | Flag da função de localização do minerador (padrão false) |
| unlocked | boolean | Sim | Status de bloqueio de tela (autorização aprovada) |
| unlock_timeout | integer (int64) | null | Não | Timeout de desbloqueio |
| warranty | string (enum) | Não | Status da garantia. Valores: active, inactive, expired, cancelled, not_provided |
Resumo geral do minerador (estatísticas de Hashrate, temperaturas, potência, Pools, Hashboards, resfriamento). Requer autorização.
Resposta 200 (OK): Summary
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| miner | object (AntmMinerStats) | null | Não | Estatísticas do minerador (ver campos chave abaixo) |
Campos chave AntmMinerStats :
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| miner_status | object (MinerStatus) | Sim | Status: miner_state, throttled, miner_state_time |
| miner_type | string | Sim | Tipo de minerador |
| hr_stock | number (float) | Sim | Hashrate de fábrica |
| hr_realtime | number (float) | Sim | Hashrate em tempo real |
| hr_nominal | number (float) | Sim | Hashrate nominal |
| hr_average | number (float) | Sim | Hashrate médio |
| average_hashrate | number (float) | Sim | Obsoleto. O mesmo que hr_average, mas em MH/s |
| instant_hashrate | number (float) | Sim | Obsoleto. O mesmo que hr_realtime, mas em MH/s |
| pcb_temp | object (TempRange) | Sim | Faixa de temperatura da PCB: min, max |
| chip_temp | object (TempRange) | Sim | Faixa de temperatura dos chips: min, max |
| power_consumption | integer (int32) | Sim | Consumo de energia |
| power_efficiency | number (float) | Sim | Eficiência energética |
| power_usage | integer (int32) | Sim | Obsoleto. O mesmo que power_efficiency |
| hw_errors | integer (int32) | Sim | Erros de hardware |
| hw_errors_percent | number (float) | Sim | Porcentagem de erros de hardware |
| hr_error | number (float) | Sim | Nível de erros de Hashrate |
| devfee | number (float) | Sim | DevFee |
| devfee_percent | number (float) | Sim | Porcentagem de DevFee |
| pools | array (PoolStats) | Sim | Estatísticas dos Pools (ver abaixo) |
| cooling | object (Cooling) | Sim | Resfriamento: fan_num, fans, settings, fan_duty |
| chains | array (AntmBoard) | Sim | Hashboards com estatísticas detalhadas |
| found_blocks | integer (int32) | Sim | Blocos encontrados |
| best_share | integer (int64) | Sim | Melhor share |
| restart_count | integer | Sim | Número de reinicializações |
| psu | object (AntmPsuInfo) | null | Não | Informações da PSU |
Objeto aninhado pools[] ( PoolStats ) — um elemento do array para cada Pool:
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| id | integer (int32) | Sim | Identificador do Pool, não negativo |
| url | string | Sim | Endereço do Pool |
| user | string | Sim | Nome de usuário/Worker |
| pool_type | string (enum) | Sim | Tipo de Pool. Valores: UserPool, DevFee, Refund |
| status | string (enum) | Sim | Status do Pool. Valores: offline, working, disabled, active, rejecting, unknown |
| diff | string | Sim | Dificuldade atual (como exibido pelo cgminer) |
| diffa | number (double) | Sim | Dificuldade média aceita |
| accepted | integer (int32) | Sim | Número de shares aceitas |
| rejected | integer (int32) | Sim | Número de shares rejeitadas |
| stale | integer (int32) | Sim | Número de shares obsoletas (stale) |
| ls_diff | number (float) | Sim | Dificuldade da última share aceita |
| ls_time | string | Sim | Tempo da última share aceita |
| ping | integer (int32) | Sim | Ping para o Pool, ms |
Objeto aninhado cooling ( Cooling ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| fan_num | integer | Sim | Número de ventiladores, não negativo |
| fan_duty | integer (int32) | Sim | Velocidade atual dos ventiladores (duty), total |
| fans | array (Fan) | Sim | Lista de ventiladores — ver detalhamento abaixo |
| settings | object (FanSettings) | Sim | Configurações do modo dos ventiladores — ver detalhamento abaixo |
Objeto aninhado em cooling fans[] ( Fan ) — um elemento do array para cada ventilador físico:
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| id | integer | Sim | Identificador do ventilador, não negativo |
| rpm | integer (int32) | Sim | RPM atual |
| max_rpm | integer (int32) | Sim | RPM máximo, não negativo |
| status | string (enum) | Sim | Status do ventilador. Valores: ok, lost (conexão perdida com o ventilador) |
Objeto aninhado em cooling settings ( FanSettings ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| mode | object (FanSettingsMode) | Sim | Modo de operação dos ventiladores — uma das três opções pelo valor de name, ver abaixo |
Objeto aninhado em settings mode ( FanSettingsMode ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| name | string (enum) | Sim | Opção de modo. Valores: auto, manual, immersion |
| param | integer (int32) | Sim (apenas para auto/manual) | Parâmetro do modo, não negativo. Ausente quando name: "immersion" |
Objeto aninhado psu ( AntmPsuInfo ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| psu_power_metering | boolean | null | Não | Suporte para medição de potência pela PSU |
| temps | object (AntmPsuTemps) | null | Não | Temperaturas da PSU — ver detalhamento abaixo |
Objeto aninhado em psu temps ( AntmPsuTemps ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| llc1_temp | integer (int32) | null | Não | Temperatura do estágio LLC 1 |
| llc2_temp | integer (int32) | null | Não | Temperatura do estágio LLC 2 |
| pfc_temp | integer (int32) | null | Não | Temperatura do estágio PFC |
Objeto aninhado chains[] ( AntmBoard ) — um elemento do array para cada Hashboard:
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| id | integer | Sim | Identificador da Hashboard, não negativo |
| frequency | number (float) | Sim | Frequência da Hashboard |
| voltage | integer (int32) | Sim | Tensão da Hashboard |
| power_consumption | integer (int32) | Sim | Consumo de energia da Hashboard |
| hashrate_ideal | number (float) | Sim | Hashrate nominal (ideal) da Hashboard |
| hashrate_rt | number (float) | Sim | Hashrate da Hashboard em tempo real |
| hashrate_percentage | number (float) | Sim | Porcentagem do Hashrate nominal |
| hr_error | number (float) | Sim | Nível de erros de Hashrate da Hashboard |
| hw_errors | integer (int32) | Sim | Número de erros de hardware da Hashboard |
| pcb_temp | object (TempRange) | Sim | Faixa de temperatura da PCB da Hashboard: min, max |
| chip_temp | object (TempRange) | Sim | Faixa de temperatura dos chips da Hashboard: min, max |
| chip_statuses | object (BoardChipStatuses) | Sim | Resumo do estado dos chips da Hashboard — ver detalhamento abaixo |
| status | object (BoardStatus) | Sim | Status da Hashboard — ver detalhamento abaixo |
| inlet_water_temp | integer (int32) | null | Não | Temperatura da água na entrada (para resfriamento líquido), não negativa |
| outlet_water_temp | integer (int32) | null | Não | Temperatura da água na saída (para resfriamento líquido), não negativa |
Objeto aninhado em chains[] chip_statuses ( BoardChipStatuses ) — número de chips por categorias:
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| red | integer (int32) | Sim | Número de chips com status "vermelho" (pior estado), não negativo |
| orange | integer (int32) | Sim | Número de chips com status "laranja" (estado intermediário), não negativo |
| grey | integer (int32) | Sim | Número de chips com status "cinza" (estado normal), não negativo |
Objeto aninhado em chains[] status ( BoardStatus ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| state | string (enum) | Sim | Estado da Hashboard. Valores: initializing, mining, stopped, failure, disconnected, disabled, unknown |
| description | string | null | Não | Descrição textual do estado (geralmente preenchida em caso de failure) |
Reinicialização do sistema. Requer autorização.
Resposta 200 (OK): RebootAfter
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| after | integer (int64) | Sim | Em quantos segundos o sistema será reiniciado (padrão 3) |
Obtenção das configurações da interface (tema, localidade, fuso horário, constantes de resfriamento/Overclock, fusos horários).
Resposta 200 (OK): UiSettings
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| theme | string (enum) | null | Não | Tema. Valores: light, dark, auto |
| locale | string (enum) | null | Não | Localidade. Valores: ru, en, fa, ua, zh, pt, ka |
| timezone | string (enum) | null | Não | Fuso horário. Valores: GMT+1…GMT+12, GMT, GMT-1…GMT-11 |
| dark_side_pane | boolean | null | Não | Painel lateral escuro |
| disable_animation | boolean | null | Não | Desativação de animação |
| consts | object (Consts) | null | Não | Constantes: cooling, overclock, timezones |
Objeto aninhado em UiSettings ( Consts ):
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| cooling | object (CoolingConsts) | Sim | Os mesmos campos já detalhados na seção 6.5.28 (GET /model): min_fan_pwm, min_target_temp, max_target_temp, fan_min_count |
| overclock | object (Overclock) | Sim | Os mesmos campos já detalhados na seção 6.5.28 (GET /model) |
| timezones | array | Não | Lista de fusos horários disponíveis para exibição na UI, pares "código → nome" |
Desbloqueio (autenticação por senha). Retorna um token JWT.
Resposta 200 (OK): UnlockSuccess
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| token | string | Sim | Token JWT de autorização |
Corpo da requisição: UnlockScreenBody
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| pw | string | Sim | Senha do dispositivo(s) alvo |
⚠️ O endpoint não é mais utilizado. Marcado como
deprecatedna especificação e mantido apenas para compatibilidade retroativa com clientes antigos. Para novas integrações, use o atualPOST /locate-miner(seção 6.5.15).
ErrDescr (utilizado nas respostas 400, 409, 500, 507 e outros)
| Parâmetro | Tipo de dados | Obrigatoriedade | Descrição |
|---|---|---|---|
| err | string | Sim | Texto do erro |