ByCloud Docs
GuidesCLIAPISDK
patch/v1/pools/{pool_id}

Update pool

Update a pool

Path Parameters

pool_id

string<uuid>required

path

Pool ID

Example: "550e8400-e29b-41d4-a716-446655440000"

Request Body

required

Content-Type: application/json

name

stringoptional

description

stringoptional

admin_state_up

booleanoptional

lb_algorithm

stringoptional

Enum: "ROUND_ROBIN", "LEAST_CONNECTIONS", "SOURCE_IP", "SOURCE_IP_PORT"

session_persistence

objectoptional

tags

arrayoptional

Responses

200

Pool updated

Content-Type: application/json

pool

objectoptional
400

Invalid request parameters

Content-Type: application/json

error

objectrequired
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
404

Resource not found

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X PATCH "https://api.spo1.mycloud.com/v1/pools/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "admin_state_up": true,
    "lb_algorithm": "ROUND_ROBIN",
    "session_persistence": {
      "type": "HTTP_COOKIE",
      "cookie_name": "string",
      "persistence_timeout": 1,
      "persistence_granularity": "string"
    },
    "tags": [
      "web",
      "frontend"
    ]
  }'