ByCloud Docs
GuidesCLIAPISDK
patch/v1/load-balancers/{load_balancer_id}

Update load balancer

Update a load balancer

Path Parameters

load_balancer_id

string<uuid>required

path

Load Balancer ID

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

Request Body

required

Content-Type: application/json

name

stringoptional

description

stringoptional

tags

arrayoptional

Responses

200

Load balancer updated

Content-Type: application/json

load_balancer

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
409

Load balancer is not in updatable state

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/load-balancers/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "tags": [
      "web",
      "frontend"
    ]
  }'

Response

Load balancer updated

{
  "load_balancer": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "crn": "crn:spo1:loadbalancer:load-balancer:550e8400-e29b-41d4-a716-446655440000",
    "name": "web-lb",
    "description": "Load balancer for web servers",
    "provisioning_status": "ACTIVE",
    "operating_status": "ONLINE",
    "vip_address": "192.168.1.100",
    "vip_port_id": "550e8400-e29b-41d4-a716-446655440000",
    "vip_subnet_id": "550e8400-e29b-41d4-a716-446655440001",
    "vip_network_id": "550e8400-e29b-41d4-a716-446655440002",
    "listeners": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "pools": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "provider": "octavia",
    "flavor_id": "550e8400-e29b-41d4-a716-446655440000",
    "tags": [
      "web",
      "frontend"
    ],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}