Skip to main content
GET
Python

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

load_balancer_id
string<uuid4>
required

Load-Balancer ID

Example:

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

Query Parameters

show_stats
boolean
default:false

Show statistics

Examples:

true

false

with_ddos
boolean
default:false

Show Advanced DDoS protection profile, if exists

Examples:

true

false

Response

200 - application/json

Load balancer

additional_vips
NetworkPortFixedIp · object[]
required

List of additional IP addresses

admin_state_up
boolean
required

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. Defaults to true.

Examples:

true

false

created_at
string<date-time>
required

Datetime when the load balancer was created

Example:

"2019-06-18T11:56:16+0000"

creator_task_id
string<uuid4> | null
required

Task that created this entity. Null when the load balancer wasn't created via a tracked task.

Example:

"9f3ec11e-bcd4-4fe6-924a-a4439a56ad22"

ddos_profile
GetClientProfileSerializer · object | null
required

Loadbalancer advanced DDoS protection profile. Null unless requested via with_ddos, or when no profile is attached.

Example:
flavor
LbFlavorSerializer · object | null
required

Load balancer flavor. Null when using the default flavor.

Example:
floating_ips
FloatingIPSerializer · object[]
required

List of assigned floating IPs

id
string<uuid4>
required

Load balancer ID

Example:

"e8ab1be4-1521-4266-be69-28dad4148a30"

listeners
ListenerSerializer · object[]
required

Load balancer listeners

logging
LoggingOutSerializer · object | null
required

Logging configuration. Null when logging isn't configured.

Example:
name
string
required

Load balancer name

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

"lbaas_test_lb"

operating_status
enum<string>
required

Load balancer operating status

Available options:
DEGRADED,
DRAINING,
ERROR,
NO_MONITOR,
OFFLINE,
ONLINE
preferred_connectivity
enum<string>
required

Preferred option to establish connectivity between load balancer and its pools members

Available options:
L2,
L3
Examples:

"L2"

"L3"

project_id
integer
required

Project ID

Example:

1337

provisioning_status
enum<string>
required

Load balancer lifecycle status

Available options:
ACTIVE,
DELETED,
ERROR,
PENDING_CREATE,
PENDING_DELETE,
PENDING_UPDATE
region
string
required

Region name

Example:

"Luxembourg 1"

region_id
integer
required

Region ID

Example:

7

stats
LoadbalancerStatsSerializer · object | null
required

Statistics of load balancer. Null unless requested via show_stats.

Example:
tags_v2
TagSerializer · object[]
required

List of key-value tags associated 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. 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:
task_id
string<uuid4> | null
required

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

updated_at
string<date-time> | null
required

Datetime when the load balancer was last updated. Null until the first update.

Example:

"2019-06-18T11:57:00+0000"

vip_address
string<ipvanyaddress>
required

Load balancer IP address

Example:

"5.5.5.5"

vip_fqdn
string | null
required

Fully qualified domain name for the load balancer VIP. Null when no FQDN is assigned.

Example:

"550e8400-e29b-41d4-a716-446655440000.lb.cloud.example.com"

vip_ip_family
enum<string> | null
required

Load balancer IP family

Available options:
dual,
ipv4,
ipv6
Example:

"ipv4"

vip_port_id
string<uuid4>
required

The ID of the Virtual IP (VIP) port.

Example:

"4177d1ef-f1c2-4e45-a531-3e05dfa6d848"

vrrp_ips
VRRPIP · object[]
required

List of VRRP IP addresses