---
title: "Update an existing pool group"
method: PUT
path: "/api/v1/pools/{uid}"
tags: ["Pools"]
---

# Update an existing pool group

`PUT /api/v1/pools/{uid}`

Updates the specified pool group with a new name, list of pools, and load balancing strategy.

## Path parameters

- `uid` string, required

## Request body

- PoolGroupConfiguration — Structure handle configured mining group
  - `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

## Response `200`

Pool group successfully updated.

- PoolGroupConfiguration — Structure handle configured mining group
  - `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

## Other responses

- `404` — Pool group not found

---

[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/versions/d341c8e1d506/schema)