Skip to main content
PATCH
Update load balancer pool member

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"

member_id
string<uuid4>
required

Member ID

Example:

"00000000-0000-4000-8000-000000000000"

Body

application/json
admin_state_up
boolean

Administrative state of the member. Omit to leave unchanged; false disables the member so it receives no traffic.

Examples:

true

false

backup
boolean

Set to true if the member is a backup member, to which traffic will be sent exclusively when all non-backup members will be unreachable. Omit to leave unchanged.

Examples:

true

false

monitor_address
string<ipvanyaddress> | null

Alternate IP address used for health monitoring of a backend member. Set to null to clear it and fall back to the member address; omit to leave unchanged.

monitor_port
integer | null

Alternate protocol port used for health monitoring of a backend member. Set to null to clear it and fall back to the member protocol_port; omit to leave unchanged.

Required range: 1 <= x <= 65535
weight
integer

Member weight. Valid values are 0 < weight <= 256. Omit to leave unchanged. Controls traffic distribution based on the pool's load balancing algorithm:

  • ROUND_ROBIN: Distributes connections to each member in turn according to weights. Higher weight = more turns in the cycle. Example: weights 3 vs 1 = ~75% vs ~25% of requests.
  • LEAST_CONNECTIONS: Sends new connections to the member with fewest active connections, performing round-robin within groups of the same normalized load. Higher weight = allowed to hold more simultaneous connections before being considered 'more loaded'. Example: weights 2 vs 1 means 20 vs 10 active connections is treated as balanced.
  • SOURCE_IP: Routes clients consistently to the same member by hashing client source IP; hash result is modulo total weight of running members. Higher weight = more hash buckets, so more client IPs map to that member. Example: weights 2 vs 1 = roughly two-thirds of distinct client IPs map to the higher-weight member.
Required range: x <= 256
Example:

1

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: