Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
Load Balancers

Get load balancer

get/cloud/v1/loadbalancers/{project_id}/{region_id}/{load_balancer_id}

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

region_idinteger required

Region ID

Example:7

Region ID

load_balancer_idstring uuid4 required

Load-Balancer ID

Example:ac307687-31a4-4a11-a949-6bea1b2878f5

Load-Balancer ID

Query parameters

show_statsboolean

Show statistics

Example:true

Show statistics

with_ddosboolean

Show Advanced DDoS protection profile, if exists

Example:true

Show Advanced DDoS protection profile, if exists

Response

OK

admin_state_upboolean 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.

created_atstring date-time required

Datetime when the load balancer was created

creator_task_idstring uuid4 nullable

Task that created this entity

idstring uuid4 required

Load balancer ID

namestring required

Load balancer name

operating_status'DEGRADED' | 'DRAINING' | 'ERROR' | 'NO_MONITOR' | 'OFFLINE' | 'ONLINE' required
preferred_connectivity'L2' | 'L3'
project_idinteger required

Project ID

provisioning_status'ACTIVE' | 'DELETED' | 'ERROR' | 'PENDING_CREATE' | 'PENDING_DELETE' | 'PENDING_UPDATE' required
regionstring required

Region name

region_idinteger required

Region ID

task_idstring uuid4 nullable

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_atstring date-time nullable

Datetime when the load balancer was last updated

vip_addressstring ipvanyaddress nullable

Load balancer IP address

vip_fqdnstring nullable

Fully qualified domain name for the load balancer VIP

vip_ip_family'dual' | 'ipv4' | 'ipv6'
vip_port_idstring uuid4 nullable

The ID of the Virtual IP (VIP) port.

Example response

{
  "additional_vips": [
    {
      "ip_address": "127.0.0.1",
      "subnet_id": "00000000-0000-4000-8000-000000000000"
    }
  ],
  "admin_state_up": true,
  "created_at": "2019-06-18T11:56:16+0000",
  "creator_task_id": "9f3ec11e-bcd4-4fe6-924a-a4439a56ad22",
  "ddos_profile": {
    "fields": [
      {
        "base_field": 10,
        "description": "ARK server ports. Valid port values are in range 1000-65535",
        "field_value": 45046,
        "id": 11,
        "name": "ARK Ports",
        "required": true,
        "validation_schema": {
          "items": {
            "maximum": 65535,
            "minimum": 1000,
            "type": "integer"
          },
          "minItems": 1,
          "type": "array"
        }
      }
    ],
    "options": {
      "active": true,
      "bgp": true
    },
    "profile_template": {
      "description": "description",
      "fields": [
        {
          "description": "ARK server ports. Valid port values are in range 1000-65535",
          "id": 11,
          "name": "ARK Ports",
          "required": true,
          "validation_schema": {
            "items": {
              "maximum": 65535,
              "minimum": 1000,
              "type": "integer"
            },
            "minItems": 1,
            "type": "array"
          }
        }
      ],
      "id": 123,
      "name": "ICMP port"
    },
    "profile_template_description": "ARK server ports. Valid port values are in range 1000-65535",
    "protocols": [
      {
        "port": "80",
        "protocols": [
          "TCP",
          "HTTP"
        ]
      },
      {
        "port": "53",
        "protocols": [
          "UDP"
        ]
      }
    ],
    "site": "ED",
    "status": {
      "error_description": "An error occured while deleting profile",
      "status": "Error Deleting"
    }
  },
  "flavor": {
    "flavor_id": "g2-standard-32-64",
    "flavor_name": "g2-standard-32-64",
    "ram": 2048,
    "vcpus": 1
  },
  "floating_ips": [
    {
      "created_at": "2019-06-13T13:58:12+0000",
      "creator_task_id": "d1e1500b-e2be-40aa-9a4b-cc493fa1af30",
      "fixed_ip_address": "192.168.10.15",
      "floating_ip_address": "172.24.4.34",
      "id": "c64e5db1-5f1f-43ec-a8d9-5090df85b82d",
      "port_id": "ee2402d0-f0cd-4503-9b75-69be1d11c5f1",
      "project_id": 1337,
      "region": "Luxembourg 1",
      "region_id": 7,
      "router_id": "11005a33-c5ac-4c96-ab6f-8f2827cc7da6",
      "tags": [
        {
          "key": "my-tag",
          "read_only": false,
          "value": "my-tag-value"
        }
      ],
      "task_id": "a4eb4b29-048e-42f6-a5e1-2c18bc001c45",
      "updated_at": "2019-06-13T13:58:12+0000"
    }
  ],
  "id": "e8ab1be4-1521-4266-be69-28dad4148a30",
  "listeners": [
    {
      "id": "43658ea9-54bd-4807-90b1-925921c9a0d1"
    }
  ],
  "logging": {
    "destination_region_id": 1,
    "enabled": true,
    "retention_policy": {
      "period": 45
    },
    "topic_name": "my-log-name"
  },
  "name": "lbaas_test_lb",
  "project_id": 1337,
  "region": "Luxembourg 1",
  "region_id": 7,
  "stats": {
    "bytes_in": 34942398609,
    "bytes_out": 304777113641,
    "request_errors": 4,
    "total_connections": 21095970
  },
  "tags_v2": [
    {
      "key": "my-tag",
      "read_only": false,
      "value": "my-tag-value"
    }
  ],
  "updated_at": "2019-06-18T11:57:00+0000",
  "vip_address": "5.5.5.5",
  "vip_fqdn": "550e8400-e29b-41d4-a716-446655440000.lb.cloud.example.com",
  "vip_port_id": "4177d1ef-f1c2-4e45-a531-3e05dfa6d848",
  "vrrp_ips": [
    {
      "ip_address": "127.0.0.1",
      "subnet_id": "00000000-0000-4000-8000-000000000000"
    }
  ]
}