Sign in

v1

latestOpenAPI 3.1.02026-07-1757128164.2 KB
Pools

Update an existing pool group

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

put/api/v1/pools/{uid}

Path parameters

uidstring required

The UID of the pool to be updated.

Request body

namestring required

Group name

uidstring 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

Pool group successfully updated.

namestring required

Group name

uidstring 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