Endpoint Reference

Activates miner warranty. Requires authorization. Returns warranty status.

Response 200: WarrantyStatus Response 200 (OK): array ApiKeysJsonItem

Retrieves a list of API keys. Requires authorization. Returns an array of keys.

Response 200 (OK): array ApiKeysJsonItem

Adds a new API key. Requires authorization. The request body contains the key and description (AddApikeyQuery = ApiKeysJsonItem).

Response 200 (OK): AddApiKeyRes

Deletes an API key. Requires authorization. The request body contains the key (DeleteApikeyQuery).

Response 200 (OK): body is empty (Key deleted successfully).

Checks authorization. Returns information about the timeout until the temporary device lock expires.

Response 200 (OK): AuthCheck

If the device is not temporarily locked, an empty object is returned:

{}

If the device is temporarily locked, the response includes the unlock_timeout field, containing the number of seconds remaining until the lock expires:

{
  "unlock_timeout":58
}

Note: The absence of the unlock_timeout field is equivalent to null and means that there is no temporary lock.

Retrieves a list of autotune presets. Requires authorization. Returns an array of presets with tuning settings.

Response 200 (OK): array AutotunePresetDto

Nested object tune_settings ( AutotuneResultsItem ):

Resets the specified list of autotune profiles. Requires authorization.

Response 200 (OK): body is empty.

Request Body: AutotuneReset

Resets all autotune profiles. Requires authorization.

Response 200 (OK): body is empty.

Request Body: AutotuneResetAll

Retrieves miner boards with chip and sensor details. No authorization required.

Response 200 (OK): array AntmBoardChips

Nested object status ( CgBoardStatus ):

Nested object sensors[] ( AntmChipSensor ) — one array element per sensor:

Nested chip object AntmChip :

Cancels miner warranty. Requires authorization.

Response 200 (OK): WarrantyStatus

Retrieves factory information about miner boards. No authorization required.

Response 200 (OK): FactoryInfoReply

Nested object: FactoryInfoBoard

Removes firmware and loads stock firmware. Requires authorization. The system will reboot after the operation.

Response 200 (OK): RebootAfter

Request Body: FwRemoveParams

Updates firmware. Requires authorization. The system will reboot after the update.

Response 200: RebootAfter

Request Body: SchemaFirmwareUpdate (multipart/form-data)

Retrieves general miner information (firmware data + model, algorithm, system). No authorization required.

Response 200 (OK): InfoJson

Nested object system ( SystemInfo ):

Nested object network_status (NetworkStatus):

Locates (highlights/finds) the miner. Returns the current state of the function. No authorization required.

Response 200 (OK): LocateMinerStatus

Locks the miner (resets the current session). Requires authorization (bearerAuth).

Response 200 (OK): body is empty.

Locks other miner sessions except the current one. Requires authorization (bearerAuth).

Response 200 (OK): body is empty.

Request Body: UnlockScreenBody

Reads a log file by type. The * type (all logs) is not implemented for this route. No authorization required.

Path Parameter:

⚠️ In practice, status, miner, hwscan, autotune, system are actually used. Values are specified in lowercase.

Response 200 (OK): log file (body without described schema).

Clears logs of the specified type. Requires authorization.

Path Parameter:

⚠️ In practice, status, miner, hwscan, autotune are actually used. Values are specified in lowercase.

Response 200 (OK): body is empty (Logs was cleared successfully).

Retrieves miner metrics for a time interval, averaged by step.

Query Parameters:

Response 200 (OK): MetricsReply

Nested metrics[].data ( MetricsData ):

Nested annotations[].data ( MetricAnnotation ):

Pauses mining. Requires authorization.

Response 200 (OK): body is empty (Mining paused).

Restarts mining. Requires authorization.

Response 200 (OK): body is empty (Mining restart).

Resumes mining. Requires authorization.

Response 200 (OK): body is empty (Mining resumed).

Starts mining. Requires authorization.

Response 200 (OK): body is empty (Mining started).

Stops mining. Requires authorization.

Response 200 (OK): body is empty (Mining stopped).

Switches the active pool. Requires authorization.

Request Body: SwitchPoolQuery

Example Request Body:

{
  "pool_id": 1
}

Response 200 (OK): body is empty (Pool was switched successfully).

Updates throttling settings. Requires authorization.

Response 200 (OK): SaveConfigResult

Request Body: ThrottleSettings

Retrieves information about the miner model (algorithm, series, platform, board topology, cooling, overclocking). No authorization required.

Response 200 (OK): MinerModelInfo

Nested object chain (ModelInfoBoard):

Nested in chain object topology(Topology):

Nested object cooling (CoolingConsts):

Nested in cooling object fan_min_count ( MinerFanMinCount ):

Nested object overclock (Overclock):

Reads all notes as a key-value dictionary.

Response 200 (OK): object (dictionary)

Request Body: NoteKeyValue

Example Request Body:

{
  "key": "pool_reminder",
  "value": "string1"
}

Response 200 (OK): body is empty (Note add successfully).

Retrieves a single note by key.

Path Parameter:

Example Request: GET {{baseUrl}}/notes/pool_reminder

Response 200 (OK): NoteValue

Updates a note by key. Requires authorization.

Path Parameter:

Request Body: NoteValue

Example Request: PUT {{baseUrl}}/notes/pool_reminder with body:

{
  "value": "string1111"
}

Response 200 (OK): body is empty (Notes add successfully).

Deletes a note by key. Requires authorization.

Path Parameter:

Response 200 (OK): body is empty (Note delete successfully).

Performance summary: current preset and preset switcher settings.

Response 200 (OK): PerfSummary

Nested object PresetSwitcherRaw :

Nested object current_preset ( CurrentPreset ):

Retrieves all miner settings. Requires authorization (apikeyAuth).

Response 200 (OK): ViewConfig

Nested object ui ( UiSettings ):

Nested in ui.consts object ( Consts ):

Nested object regional ( RegionalSettings ):

Nested object network ( NetworkConfFile ):

Nested object password ( PasswordChange ):

Nested in ViewConfig object miner ( MinerConfigRaw ):

Nested in miner object cooling ( CoolingSettingsRaw ):

Nested in cooling object mode ( ModeRaw ) — one of three options (by name value):

Nested in miner object misc (AdvancedSettingsRaw) — all fields are optional (null if not set):

Nested in miner object overclock ( OverclockSettingsRaw ):

Nested in overclock object globals ( GlobalsRaw ):

Nested in overclock object chains[] ( BoardRaw ) — one array element per board:

Saves miner settings. Requires authorization.

Response 200 (OK): SaveConfigResult

Request Body: InputConfig (all fields optional, nullable)

Nested object network ( InputNetworkConfFile ) — this is NetworkConfFile plus one additional field:

Nested object password ( PasswordChange ):

Nested object regional ( RegionalSettings ):

Nested in regional.timezone object ( TimezoneSettings ):

Nested object ui ( UiSettings ):

Nested in ui.consts object ( Consts ):

Backs up settings. Requires authorization. Returns a binary file.

Response 200 (OK): binary data (application/octet-stream, byte array). The server returns an archive (.tar.gz) which, when unpacked, contains a set of miner configuration files.

Real Archive Content (example):

Resets settings to factory defaults. Requires authorization. The system will reboot after the operation.

Response 200 (OK): RebootAfter

Restores settings from a file. Requires authorization. If warranty is active, 403 will be returned (warranty must be canceled first: /cancel-warranty). The system will reboot after the operation.

Response 200 (OK): RebootAfter

Request Body: SchemaSettingsRestore (multipart/form-data)

Retrieves miner status (state, throttling, restart requirements, localization, warranty). Authorization not specified.

Response 200 (OK): StatusPane

General miner summary (Hashrate statistics, temperatures, power, pools, boards, cooling). Requires authorization.

Response 200 (OK): Summary

Key fields AntmMinerStats :

Nested object pools[] ( PoolStats ) — one array element per pool:

Nested object cooling ( Cooling ):

Nested in cooling object fans[] ( Fan ) — one array element per physical fan:

Nested in cooling object settings ( FanSettings ):

Nested in settings object mode ( FanSettingsMode ):

Nested object psu ( AntmPsuInfo ):

Nested in psu object temps ( AntmPsuTemps ):

Nested object chains[] ( AntmBoard ) — one array element per board:

Nested in chains[] object chip_statuses ( BoardChipStatuses ) — number of chips by categories:

Nested in chains[] object status ( BoardStatus ):

Reboots the system. Requires authorization.

Response 200 (OK): RebootAfter

Retrieves UI settings (theme, locale, timezone, cooling/overclocking constants, timezones).

Response 200 (OK): UiSettings

Nested in UiSettings object ( Consts ):

Unlocks (authenticates with password). Returns a JWT token.

Response 200 (OK): UnlockSuccess

Request Body: UnlockScreenBody

⚠️ This endpoint is no longer used. It is marked as deprecated in the specification and kept only for backward compatibility with older clients. For new integrations, use the current POST /locate-miner (section 6.5.15).

ErrDescr (used in 400, 409, 500, 507 and other responses)