Create load balancer

POST /cloud/v1/loadbalancers/{project_id}/{region_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.create(
    project_id=1,
    region_id=7,
    name="new_load_balancer",
)
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:

7

Body

application/json

name · string · required

Load balancer name.

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

Example:

"new_load_balancer"

flavor · string

Load balancer flavor name

Examples:

"lb1-1-2"

"lb2-2-2"

floating_ip · New floating IP · object

Floating IP configuration for assignment

New floating IP

Existing floating IP

Show child attributes

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

logging · LoadbalancerLoggingSerializer · object

Logging configuration

Show child attributes

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

Examples:

"L2"

"L3"

tags · CreateTagsSerializer · object

Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.

Example:

{ "my-tag": "my-tag-value" }

vip_ip_family · enum<string>

IP family for load balancer subnet auto-selection if vip_network_id is specified

Available options: dual, ipv4, ipv6

Example:

"ipv4"

vip_network_id · string<uuid4>

Network ID for load balancer. If not specified, default external network will be used. Mutually exclusive with vip_port_id

Example:

"ac307687-31a4-4a11-a949-6bea1b2878f5"

vip_port_id · string<uuid4>

Existing Reserved Fixed IP port ID for load balancer. Mutually exclusive with vip_network_id

Example:

"ff83e13a-b256-4be2-ba5d-028d3f0ab450"

vip_subnet_id · string<uuid4>

Subnet ID for load balancer. If not specified, any subnet from vip_network_id will be selected. Ignored when vip_network_id is not specified.

Example:

"4e7802d3-5023-44b8-b298-7726558fddf4"

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"]