Load Balancer

Create Load Balancer

post/loadbalancer/

Create a new Load Balancer.

Authorization

Authorization*string

Bearer YOUR_API_TOKEN with an API token. The X-API-Key: YOUR_API_TOKEN header works too.

Request body

Create a new Load Balancer

application/jsonRequired

name*string

Load balancer name

Range1 ≤ length ≤ 100

label?string | null

Optional label

Rangelength ≤ 255

plan_name*string

Plan name (e.g., lb.small, lb.medium)

location_name*string

Location name (e.g., us-mia-1)

project_id?integer | null

Project ID (uses default project if not specified)

network_id?integer | null

Optional private network to attach the LB to. When set, the LB gets a private NIC on this network and reaches targets by their private IP on the same network (it never falls back to public IPs). Must be in the same location as the LB.

Responses

Successful Response

application/json

uuid*string

name*string

label?string | null

status*string

plan*LBPlanDetailOut

Plan the Load Balancer runs on.

Properties (7)

uuid*string

name*string

description?string | null

price_per_hour*number

max_targets?integer | null

max_listeners?integer | null

connections_per_second?integer | null

location_name?string | null

project_id?integer | null

project_name?string | null

floating_ip?LBFloatingIPSummaryOut | null

Primary public IP of the Load Balancer.

Properties (4)

address*string

netmask?string | null

type?string | null

rdns?string | null

listeners?array<LBListenerSummaryOut>

Properties (7)

uuid*string

name*string

protocol?string | null

source_port*integer

target_port*integer

enabled?boolean | null

targets_count?integer

Default0

protected?boolean

Defaultfalse

created_at?string | null

updated_at?string | null