Create load balancer

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

region_id

integer

required

Region ID

Body

application/json

flavor

string

Load balancer flavor name

floating_ip

New floating IP · object

Floating IP configuration for assignment

New floating IP
Existing floating IP

Show child attributes

floating_ip.source

string

required

A new floating IP will be created and attached to the instance. A floating IP is a public IP that makes the instance accessible from the internet, even if it only has a private IP. It works like SNAT, allowing outgoing and incoming traffic.

Allowed value: "new"

Example:

{
  "existing_floating_id": "c64e5db1-5f1f-43ec-a8d9-5090df85b82d",
  "source": "existing"
}

listeners

CreateListenerSerializer · object[]

Load balancer listeners. Maximum 50 per LB (excluding Prometheus endpoint listener).

Maximum array length: 51

Show child attributes

listeners.name

string

required

Load balancer listener name

listeners.protocol

enum<string>

required

Load balancer listener protocol

Available options:

HTTP,

HTTPS,

PROMETHEUS,

TCP,

TERMINATED_HTTPS,

UDP

listeners.protocol_port

integer

required

Protocol port

Required range: 1 <= x <= 65535

listeners.allowed_cidrs

string<ipvanynetwork>[] | null

Network CIDRs from which service will be accessible

Example:

["10.0.0.0/8"]

listeners.connection_limit

integer

default:100000

Limit of the simultaneous connections. If -1 is provided, it is translated to the default value 100000.

Required range: -1 <= x <= 1000000

listeners.insert_x_forwarded

boolean

Add headers X-Forwarded-For, X-Forwarded-Port, X-Forwarded-Proto to requests. Only used with HTTP or TERMINATED_HTTPS protocols.

listeners.pools

CreateLbPoolSerializer · object[]

Member pools

Maximum array length: 1

Show child attributes

listeners.pools.lb_algorithm

enum<string>

required

Load balancer algorithm

Available options:

LEAST_CONNECTIONS,

ROUND_ROBIN,

SOURCE_IP

listeners.pools.name

string

required

Pool name

listeners.pools.protocol

enum<string>

required

Protocol

Available options:

HTTP,

HTTPS,

PROXY,

PROXYV2,

TCP,

UDP

listeners.pools.ca_secret_id

string<uuid4> | null

Secret ID of CA certificate bundle

listeners.pools.crl_secret_id

string<uuid4> | null

Secret ID of CA revocation list file

listeners.pools.healthmonitor

CreateLbHealthMonitorSerializer · object

Health monitor details

Show child attributes

listeners.pools.healthmonitor.delay

integer

required

The time, in seconds, between sending probes to members

Required range: 1 <= x <= 2147483647

listeners.pools.healthmonitor.max_retries

integer

required

Number of successes before the member is switched to ONLINE state

Required range: 1 <= x <= 10

listeners.pools.healthmonitor.timeout

integer

required

The maximum time to connect. Must be less than the delay value

Required range: x <= 2147483

listeners.pools.healthmonitor.type

enum<string>

required

Health monitor type. Once health monitor is created, cannot be changed.

Available options:

HTTP,

HTTPS,

K8S,

PING,

TCP,

TLS-HELLO,

UDP-CONNECT

listeners.pools.healthmonitor.expected_codes

string | null

Expected HTTP response codes. Can be a single code or a range of codes. Can only be used together with HTTP or HTTPS health monitor type. For example, 200,202,300-302,401,403,404,500-504. If not specified, the default is 200.

Example:

"200,301,302"

listeners.pools.healthmonitor.http_method

enum<string> | null

HTTP method. Can only be used together with HTTP or HTTPS health monitor type.

Available options:

CONNECT,

DELETE,

GET,

HEAD,

OPTIONS,

PATCH,

POST,

PUT,

TRACE

Example:

"CONNECT"

listeners.pools.healthmonitor.max_retries_down

integer

Number of failures before the member is switched to ERROR state.

Required range: 1 <= x <= 10

listeners.pools.healthmonitor.url_path

string | null

URL Path. Defaults to '/'. Can only be used together with HTTP or HTTPS health monitor type.

Minimum string length: 1

Example:

"/"

Example:

{
  "delay": 10,
  "http_method": "GET",
  "max_retries": 3,
  "max_retries_down": 3,
  "timeout": 5,
  "type": "HTTP",
  "url_path": "/"
}

listeners.pools.listener_id

string<uuid4> | null

Listener ID

listeners.pools.load_balancer_id

string<uuid4> | null

Loadbalancer ID

Example:

"bbb35f84-35cc-4b2f-84c2-a6a29bba68aa"

listeners.pools.members

CreateLbPoolMemberSerializer · object[]

Pool members

Show child attributes

listeners.pools.members.address

string<ipvanyaddress>

required

Member IP address

listeners.pools.members.protocol_port

integer

required

Member IP port

listeners.pools.members.admin_state_up

boolean

default:true

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. When null is passed, the value is skipped and defaults to true.

listeners.pools.members.backup

boolean

default:false

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. It allows to realize ACTIVE-BACKUP load balancing without thinking about VRRP and VIP configuration. Default is false.

listeners.pools.members.instance_id

string<uuid4> | null

Either subnet_id or instance_id should be provided

Example:

"a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9"

listeners.pools.members.monitor_address

string<ipvanyaddress> | null

An alternate IP address used for health monitoring of a backend member. Default is null which monitors the member address.

listeners.pools.members.monitor_port

integer | null

An alternate protocol port used for health monitoring of a backend member. Default is null which monitors the member protocol_port.

listeners.pools.members.subnet_id

string<uuid4> | null

subnet_id in which address is present. Either subnet_id or instance_id should be provided

Example:

"32283b0b-b560-4690-810c-f672cbb2e28d"

listeners.pools.members.weight

integer

Member weight. Valid values are 0 < weight <= 256, defaults to 1. 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

listeners.pools.secret_id

string<uuid4> | null

Secret ID for TLS client authentication to the member servers

listeners.pools.session_persistence

MutateLbSessionPersistence · object

Session persistence details

Show child attributes

listeners.pools.session_persistence.type

enum<string>

required

Session persistence type

Available options:

APP_COOKIE,

HTTP_COOKIE,

SOURCE_IP

Should be set if app cookie or http cookie is used

Example:

"cookie_name"

listeners.pools.session_persistence.persistence_granularity

string | null

Subnet mask if source_ip is used. For UDP ports only

listeners.pools.session_persistence.persistence_timeout

integer | null

Session persistence timeout. For UDP ports only

Example:

{
  "cookie_name": "cookie_name",
  "type": "APP_COOKIE"
}

listeners.pools.timeout_client_data

integer | null

Frontend client inactivity timeout in milliseconds

Required range: 0 <= x <= 86400000

Example:

50000

listeners.pools.timeout_member_connect

integer | null

Backend member connection timeout in milliseconds

Required range: 0 <= x <= 86400000

Example:

50000

listeners.pools.timeout_member_data

integer | null

Backend member inactivity timeout in milliseconds

Required range: 0 <= x <= 86400000

listeners.secret_id

ID of the secret where PKCS12 file is stored for TERMINATED_HTTPS or PROMETHEUS listener

Allowed value: ""

Example:

"f2e734d0-fa2b-42c2-ad33-4c6db5101e00"

listeners.sni_secret_id

string<uuid4>[]

List of secrets IDs containing PKCS12 format certificate/key bundles for TERMINATED_HTTPS or PROMETHEUS listeners

listeners.timeout_client_data

integer | null

Frontend client inactivity timeout in milliseconds

Required range: 0 <= x <= 86400000

Example:

50000

listeners.timeout_member_connect

integer | null

Backend member connection timeout in milliseconds

Required range: 0 <= x <= 86400000

Example:

50000

listeners.timeout_member_data

integer | null

Backend member inactivity timeout in milliseconds

Required range: 0 <= x <= 86400000

Example:

null

listeners.user_list

UserListItem · object[]

Load balancer listener list of username and encrypted password items

Show child attributes

listeners.user_list.encrypted_password

string

required

Encrypted password to auth via Basic Authentication

Maximum string length: 128

listeners.user_list.username

string

required

Username to auth via Basic Authentication

logging

LoadbalancerLoggingSerializer · object

Logging configuration

Show child attributes

logging.destination_region_id

integer | null

Destination region id to which the logs will be written

Example:

1

logging.enabled

boolean

default:false

Enable/disable forwarding logs to LaaS

logging.retention_policy

LaasIndexRetentionPolicyPydanticSerializer · object

The logs retention policy

Show child attributes

logging.retention_policy.period

integer | null

required

Duration of days for which logs must be kept.

Required range: 0 < x <= 1825

Example:

45

Example:

{ "period": 45 }

logging.topic_name

string | null

The topic name to which the logs will be written

Required string length: 1 - 223

Example:

"my-log-name"

name

string

Load balancer name. Either name or name_template should be specified.

name_template

string

Load balancer name which will be changed by template. Either name or name_template should be specified.

preferred_connectivity

enum<string>

default:L2

Preferred option to establish connectivity between load balancer and its pools members. L2 provides best performance, L3 provides less IPs usage. It is taking effect only if instance_id + ip_address is provided, not subnet_id + ip_address, because we're considering this as intentional subnet_id specification.

Available options:

L2,

L3

Response

200 - application/json

List of created tasks

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.

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

Create load balancer

Authorizations

Path Parameters

Body

Response