v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB

Load Balancers

Update load balancer

Rename load balancer, activate/deactivate logging, update preferred connectivity type, modify load balancer tags, and/or set admin_state_up to enable/disable the load balancer. The request will only process the fields that are provided in the request body. Any fields that are not included will remain unchanged.

patch/cloud/v2/loadbalancers/{project_id}/{region_id}/{load_balancer_id}

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

region_idinteger required

Region ID

Example:1

Region ID

load_balancer_idstring uuid4 required

Load balancer ID

Example:00000000-0000-4000-8000-000000000000

Load balancer ID

Request body

admin_state_upboolean

Administrative state of the resource. When set to true, the resource is enabled and operational. When set to false, the resource is disabled and will not process traffic. Defaults to true.

namestring

Name.

preferred_connectivity'L2' | 'L3'

tagsUpdateTagsSerializer

Example request

{
  "admin_state_up": true,
  "logging": {
    "destination_region_id": 1,
    "enabled": true,
    "retention_policy": {
      "period": 45
    },
    "topic_name": "my-log-name"
  },
  "name": "some_name"
}

Response

tasksstring[] required

List of task IDs representing asynchronous operations. Use these IDs to monitor operation progress:

GET /v1/tasks/{task_id} - Check individual task status and details Poll task status until completion (FINISHED/ERROR) before proceeding with dependent operations.

idstring required

Example response

{
  "tasks": [
    "d478ae29-dedc-4869-82f0-96104425f565"
  ]
}