Update load balancer pool

Updates the specified load balancer pool with the provided changes.

Behavior:

• Simple fields (strings, numbers, booleans) will be updated if provided
• Complex objects (nested structures like members, health monitors, etc.) must be specified completely - partial updates are not supported for these objects
• Undefined fields will remain unchanged
• If no change is detected for a specific field compared to the current pool state, that field will be skipped
• If no changes are detected at all across all fields, no task will be created and an empty task list will be returned

Examples of complex objects that require full specification:

• Pool members: All member properties must be provided when updating members
• Health monitors: Complete health monitor configuration must be specified
• Session persistence: Full session persistence settings must be included

PATCH /cloud/v2/lbpools/{project_id}/{region_id}/{pool_id}

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
task_id_list = client.cloud.load_balancers.pools.update(
    pool_id="00000000-0000-4000-8000-000000000000",
    project_id=1,
    region_id=1,
)
print(task_id_list.tasks)

200

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

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id · integer · required

Project ID

Example:

1

region_id · integer · required

Region ID

Example:

1

pool_id · string<uuid4> · required

Pool ID

Example:

"00000000-0000-4000-8000-000000000000"

Body

application/json

admin_state_up · boolean

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.

Examples:

true

false

ca_secret_id · string<uuid4> | null

Secret ID of CA certificate bundle

crl_secret_id · string<uuid4> | null

Secret ID of CA revocation list file

healthmonitor · PatchLbHealthMonitorSerializer · object

New pool health monitor settings

Show child attributes

lb_algorithm · enum<string>

New load balancer pool algorithm of how to distribute requests

Available options: LEAST_CONNECTIONS, ROUND_ROBIN, SOURCE_IP

Example:

"ROUND_ROBIN"

members · CreateLbPoolMemberSerializer · object[] | null

New sequence of load balancer pool members. If members are the same (by address + port), they will be kept as is without recreation and downtime.

Show child attributes

Example:

[
  {
    "address": "192.168.40.33",
    "id": "a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9",
    "operating_status": "NO_MONITOR",
    "protocol_port": 80,
    "subnet_id": "32283b0b-b560-4690-810c-f672cbb2e28d",
    "weight": 1
  }
]

name · string

New pool name

Pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$

Example:

"new_pool_name"

protocol · enum<string>

New communication protocol

Available options: HTTP, HTTPS, PROXY, PROXYV2, TCP, UDP

Example:

"HTTP"

secret_id · string<uuid4> | null

Secret ID for TLS client authentication to the member servers

session_persistence · MutateLbSessionPersistence · object

New session persistence settings

Show child attributes

timeout_client_data · integer | null · deprecated

Frontend client inactivity timeout in milliseconds. We are recommending to use listener.timeout_client_data instead.

Required range: 0 <= x <= 86400000

Example:

50000

timeout_member_connect · integer | null

Backend member connection timeout in milliseconds

Required range: 0 <= x <= 86400000

Example:

50000

timeout_member_data · integer | null

Backend member inactivity timeout in milliseconds

Required range: 0 <= x <= 86400000

Example:

0

Response

200 - application/json

OK

tasks · string[] · 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.

Example:

["d478ae29-dedc-4869-82f0-96104425f565"]