---
title: "Set cooling mode"
method: PUT
path: "/api/v1/cooling/mode"
tags: ["Cooling"]
---

# Set cooling mode

`PUT /api/v1/cooling/mode`

Sets the active cooling mode for the miner. The mode can be set to auto, manual, immersion, or hydro.

## Request body

- union — Cooling mode to set. If the cooling mode is changed, all fields that aren't relevant to the new mode are reset to default values. If the cooling mode values are updated, the new values are applied to the current mode.
  - 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
          - object
            - `auto` AutoPauseMode, required — Automatic pause mode starts with fans going with last fan speed used for mining and slowly decreases speed down to 0%
          - object
            - `manual` ManualPauseMode, required — Manual pause mode runs with defined fixed fans speed and either turns off after a certain period of time or runs indefinitely according to fan_runtime settings
              - …
      - `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
          - object
            - `auto` AutoPauseMode, required — Automatic pause mode starts with fans going with last fan speed used for mining and slowly decreases speed down to 0%
          - object
            - `manual` ManualPauseMode, required — Manual pause mode runs with defined fixed fans speed and either turns off after a certain period of time or runs indefinitely according to fan_runtime settings
              - …
      - `target_temperature` Temperature
        - `degree_c` number, double, required
  - 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

## Response `200`

Successful response containing active cooling mode

- union — The resulting cooling mode
  - 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
          - object
            - `auto` AutoPauseMode, required — Automatic pause mode starts with fans going with last fan speed used for mining and slowly decreases speed down to 0%
          - object
            - `manual` ManualPauseMode, required — Manual pause mode runs with defined fixed fans speed and either turns off after a certain period of time or runs indefinitely according to fan_runtime settings
              - …
      - `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
          - object
            - `auto` AutoPauseMode, required — Automatic pause mode starts with fans going with last fan speed used for mining and slowly decreases speed down to 0%
          - object
            - `manual` ManualPauseMode, required — Manual pause mode runs with defined fixed fans speed and either turns off after a certain period of time or runs indefinitely according to fan_runtime settings
              - …
      - `target_temperature` Temperature
        - `degree_c` number, double, required
  - 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

---

[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)