load-balancer

Create load balancer member

Creates a new member by given {service-uuid} and {backend-name}.

post/1.3/load-balancer/{service-uuid}/backends/{backend-name}/members

Request

Base URL: https://api.upcloud.com
URL: https://api.upcloud.com/1.3/load-balancer/{service-uuid}/backends/{backend-name}/members
Auth: HTTP bearer

Path parameters

service-uuidstring uuid required

The UUID of the service.

Example:01234567-89ab-cdef-0123-456789abcdef

The unique identifier for the service.

backend-namestring required

The name of the backend.

Example:backend-infra

The unique identifier for the backend.

Request body

type'dynamic' required

Member type

namestring domainname required

Name of the member

server_uuidstring uuid

Target server UUID

weightinteger required

Target weight

max_sessionsinteger required

Maximum number of sessions before queueing

enabledboolean required

Is member enabled

backupboolean

Is backup member

Example request

{
  "name": "member-1",
  "weight": 100,
  "max_sessions": 1000,
  "type": "dynamic",
  "enabled": true
}

Response

Created

namestring required

Human-readable name assigned to the backend member.

ipstring ipv4 required

IP address of the backend member server.

portinteger required

Port number on which the backend member server listens.

weightinteger required

Relative weight for load balancing, determining the proportion of requests sent to this member.

max_sessionsinteger required

Maximum number of concurrent connections allowed to this backend member.

type'static' | 'dynamic' required

Type of backend configuration. Allowed values are 'static' and 'dynamic'.

enabledboolean required

Indicates whether the backend member is actively participating in load balancing.

backupboolean required

Indicates whether this member serves as a backup, only receiving traffic when all primary members are unavailable.

created_atstring date-time required

Timestamp when the backend member was created (RFC 3339 format).

updated_atstring date-time required

Timestamp when the backend member was last updated (RFC 3339 format).

Example response

{
  "name": "member-1",
  "ip": "192.168.1.10",
  "port": 8080,
  "weight": 10,
  "max_sessions": 100,
  "type": "static",
  "enabled": true,
  "backup": false,
  "created_at": "2025-11-05T12:30:00.000Z",
  "updated_at": "2025-11-05T13:45:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.