---
title: "Get miner configuration"
method: GET
path: "/api/v1/configuration/miner"
tags: ["Configuration"]
---

# Get miner configuration

`GET /api/v1/configuration/miner`

## Response `200`

Successful response containing miner configuration

- GetMinerConfigurationResponse — Structure to return miner configuration
  - `dps` DpsConfiguration
    - `enabled` boolean, nullable — Flag if Dynamic Performance Scaling is enabled
    - `hashrate_step` TeraHashrate
      - `terahash_per_second` number, double, required
    - `min_hashrate_target` TeraHashrate
      - `terahash_per_second` number, double, required
    - `min_power_target` Power
      - `watt` integer, required
    - `mode` integer, nullable — Dynamic Performance Scaling mode
    - `on_start_target_percent` integer, nullable — Initial target for Dynamic Performance Scaling in percent
    - `power_step` Power
      - `watt` integer, required
    - `shutdown_duration` Hours
      - `hours` integer, required
    - `shutdown_enabled` boolean, nullable — Flag if shutdown for Dynamic Performance Scaling is enabled
  - `hashboard_config` HashboardPerformanceConfiguration
    - `global_frequency` Frequency
      - `hertz` number, double, required
    - `global_voltage` Voltage
      - `volt` number, double, required
    - `hashboards` HashboardConfig[], required — Per hashboard frequency/voltage. It has higher priority than global one
      - `enabled` boolean, nullable — Flag if HB si enabled
      - `frequency` Frequency
        - `hertz` number, double, required
      - `id` string, required — Hashboard id
      - `voltage` Voltage
        - `volt` number, double, required
    - `quick_ramping_time_down_s` integer, nullable — Quick ramping time down in seconds. Used in curtailments
    - `quick_ramping_time_up_s` integer, nullable — Quick ramping time up in seconds. Used in curtailments
  - `pool_groups` PoolGroupConfiguration[], required — Pool groups configuration
    - `load_balance_strategy` union — Group load balance strategy
      - object
        - `quota` Quota, required — Structure for quota load balance strategy
          - `value` integer, required
      - object
        - `fixedshareratio` FixedShareRatio, required — Structure for fixed share ratio load balance strategy Fixed share ratio is value between 0.0 to 1.0 where 1.0 represents that all work is generated from the group
          - `value` number, double, required
    - `name` string, required — Group name
    - `pools` PoolConfiguration[], required — Group pools
      - `enabled` boolean, nullable — Flag if pool connection is enabled
      - `password` string, nullable — Pool connection password if set
      - `uid` string, nullable — Pool connection id<br> If this struct is used when creating a new Pool Configuration, this field must not be specified (it will be generated)<br> If this struct is used when updating an existing configuration, this field must be specified and represents unique id of pool which will be updated
      - `url` string, required — Pool connection URL
      - `user` string, required — Pool connection user
    - `uid` string, nullable — Group id<br> gRPC: If this struct is used when creating a new Pool Group, this field must not be specified (it will be generated)<br> gRPC: If this struct is used when updating an existing Pool Group, this field must be specified and represents unique id of Pool group which will be updated<br> REST: If this struct is used when creating a new Pool Group, this field must not be specified (it will be generated)<br> REST: If this struct is used when updating an existing Pool Group, this field must not be specified, uid in URL must be specified and represents unique id of Pool group which will be updated
  - `temperature` CoolingConfiguration
    - `minimum_required_fans` integer, nullable — Minimum number of fans required to have BOSminer operational.
    - `mode` union
      - object
        - `auto` CoolingAutoMode, required — The temperature control modes. Miner software tries to regulate the fan speed so that miner temperature is approximately at the target temperature. The allowed temperature range is 0-200 degree Celsius.
          - `dangerous_temperature` Temperature
            - `degree_c` number, double, required
          - `hot_temperature` Temperature
            - `degree_c` number, double, required
          - `max_fan_speed` integer, nullable — Maximum fan speed expressed as a value between 0 and 100. max_fan_speed must be greater than min_fan_speed.
          - `min_fan_speed` integer, nullable — Minimum fan speed expressed as a value between 0 and 100. min_fan_speed must be less than max_fan_speed.
          - `minimum_required_fans` integer, nullable — Minimum number of fans required to have BOSminer operational.
          - `pause_mode` PauseMode — Pause mode to control fans behaviour after you pause the miner
            - `mode` union
              - …
          - `target_temperature` Temperature
            - `degree_c` number, double, required
      - object
        - `manual` CoolingManualMode, required — Fans are kept at a fixed, user-defined speed, no matter the temperature.
          - `dangerous_temperature` Temperature
            - `degree_c` number, double, required
          - `fan_speed_ratio` number, double, nullable — User defined fan speed expressed as a ratio between 0.0 and 1.0 where 0.0 means completely turned off and 1.0 means running at full speed possible
          - `hot_temperature` Temperature
            - `degree_c` number, double, required
          - `minimum_required_fans` integer, nullable — Minimum number of fans required to have BOSminer operational.
          - `pause_mode` PauseMode — Pause mode to control fans behaviour after you pause the miner
            - `mode` union
              - …
          - `target_temperature` Temperature
            - `degree_c` number, double, required
      - object
        - `disabled` CoolingDisabledMode, required — Disable temperature control. May be dangerous. DEPRECATED: Since Braiins OS 24.XX it is not possible to disable cooling mode.
          - `fan_speed_ratio` number, double, nullable — User defined fan speed expressed as a ratio between 0.0 and 1.0 where 0.0 means completely turned off and 1.0 means running at full speed possible
      - object
        - `immersion` CoolingImmersionMode, required
          - `dangerous_temperature` Temperature
            - `degree_c` number, double, required
          - `hot_temperature` Temperature
            - `degree_c` number, double, required
          - `target_temperature` Temperature
            - `degree_c` number, double, required
      - object
        - `hydro` CoolingHydroMode, required
          - `dangerous_temperature` Temperature
            - `degree_c` number, double, required
          - `hot_temperature` Temperature
            - `degree_c` number, double, required
          - `target_temperature` Temperature
            - `degree_c` number, double, required
  - `tuner` TunerConfiguration
    - `enabled` boolean, nullable — Flag if tuner is enabled
    - `hashrate_target` TeraHashrate
      - `terahash_per_second` number, double, required
    - `power_target` Power
      - `watt` integer, required
    - `tuner_mode` integer, nullable — Tuner mode

---

[API](https://skmtc.net/256foundation/apis/braiins-os-public-rest-api.md) · [All operations](https://skmtc.net/256foundation/apis/braiins-os-public-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/256foundation/braiins-os-public-rest-api/revisions/d341c8e1d506/schema)