Skip to main content
GET
/
cloud
/
v1
/
loadbalancers
/
{project_id}
/
{region_id}
List load balancers
curl --request GET \
  --url https://api.gcore.com/cloud/v1/loadbalancers/{project_id}/{region_id} \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "results": [
    {
      "admin_state_up": true,
      "created_at": "2019-06-18T11:56:16+0000",
      "id": "e8ab1be4-1521-4266-be69-28dad4148a30",
      "name": "lbaas_test_lb",
      "project_id": 1337,
      "region": "Luxembourg 1",
      "region_id": 7,
      "tags_v2": [
        {
          "key": "my-tag",
          "read_only": false,
          "value": "my-tag-value"
        }
      ],
      "additional_vips": [
        {
          "ip_address": "127.0.0.1",
          "subnet_id": "00000000-0000-4000-8000-000000000000"
        }
      ],
      "creator_task_id": "9f3ec11e-bcd4-4fe6-924a-a4439a56ad22",
      "ddos_profile": {
        "fields": [
          {
            "base_field": 10,
            "default": null,
            "description": "ARK server ports. Valid port values are in range 1000-65535",
            "field_type": null,
            "field_value": [
              45046,
              45047
            ],
            "id": 11,
            "name": "ARK Ports",
            "required": true,
            "validation_schema": {
              "items": {
                "maximum": 65535,
                "minimum": 1000,
                "type": "integer"
              },
              "minItems": 1,
              "type": "array"
            },
            "value": null
          }
        ],
        "id": 0,
        "options": {
          "active": true,
          "bgp": true
        },
        "profile_template": {
          "description": "test client profile template",
          "fields": [
            {
              "default": null,
              "description": "ARK server ports. Valid port values are in range 1000-65535",
              "field_type": null,
              "id": 11,
              "name": "ARK Ports",
              "required": true,
              "validation_schema": {
                "items": {
                  "maximum": 65535,
                  "minimum": 1000,
                  "type": "integer"
                },
                "minItems": 1,
                "type": "array"
              }
            }
          ],
          "id": 0,
          "name": "test_client_profile_template"
        },
        "profile_template_description": "ARK server ports. Valid port values are in range 1000-65535",
        "protocols": [
          {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          }
        ],
        "site": "ED",
        "status": {
          "error_description": "",
          "status": "Updated"
        }
      },
      "flavor": {
        "flavor_id": "1d276f53-2834-4855-9859-aa922f073055",
        "flavor_name": "lb1-1-2",
        "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",
          "status": "ACTIVE",
          "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"
        }
      ],
      "listeners": [
        {
          "id": "43658ea9-54bd-4807-90b1-925921c9a0d1"
        }
      ],
      "logging": {
        "destination_region_id": 1,
        "enabled": true,
        "retention_policy": {
          "period": 45
        },
        "topic_name": "my-log-name"
      },
      "preferred_connectivity": "L2",
      "stats": {
        "active_connections": 0,
        "bytes_in": 34942398609,
        "bytes_out": 304777113641,
        "request_errors": 4,
        "total_connections": 21095970
      },
      "task_id": "<string>",
      "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_ip_family": "ipv4",
      "vip_port_id": "4177d1ef-f1c2-4e45-a531-3e05dfa6d848",
      "vrrp_ips": [
        {
          "ip_address": "127.0.0.1",
          "subnet_id": "00000000-0000-4000-8000-000000000000"
        }
      ]
    }
  ]
}

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

Query Parameters

​
assigned_floating
boolean

With or without assigned floating IP

Examples:

true

false

​
limit
integer
default:1000

Limit of items on a single page

Required range: x <= 1000
Example:

1000

​
logging_enabled
boolean

With or without logging enabled

​
name
string

Filter by name

Example:

"lb_name"

​
offset
integer
default:0

Offset in results list

Required range: x >= 0
Example:

0

​
operating_status
enum<string>

Filter by operating status

Available options:
DEGRADED,
DRAINING,
ERROR,
NO_MONITOR,
OFFLINE,
ONLINE
Examples:

"ONLINE"

"DRAINING"

"OFFLINE"

"DEGRADED"

"ERROR"

"NO_MONITOR"

​
order_by
enum<string>
default:created_at.desc

Order by field and direction.

Available options:
created_at.asc,
created_at.desc,
flavor.asc,
flavor.desc,
name.asc,
name.desc,
operating_status.asc,
operating_status.desc,
provisioning_status.asc,
provisioning_status.desc,
updated_at.asc,
updated_at.desc,
vip_address.asc,
vip_address.desc,
vip_ip_family.asc,
vip_ip_family.desc
Example:

"name.asc"

​
provisioning_status
enum<string>

Filter by provisioning (lifecycle) status

Available options:
ACTIVE,
DELETED,
ERROR,
PENDING_CREATE,
PENDING_DELETE,
PENDING_UPDATE
Examples:

"ACTIVE"

"DELETED"

"ERROR"

"PENDING_CREATE"

"PENDING_UPDATE"

"PENDING_DELETE"

​
show_stats
boolean
default:false

Show statistics

Examples:

true

false

​
tag_key
string[]

Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.

Required string length: 1 - 255
Pattern: ^[^\s=]+$
Example:
["key1", "key2"]
​
tag_key_value
string

Optional. Filter by tag key-value pairs.

Example:
{ "key": "value" }
​
with_ddos
boolean
default:false

Show Advanced DDoS protection profile, if exists

Examples:

true

false

Response

200 - application/json

OK

​
count
integer
required

Number of objects

Required range: x >= 0
Example:

1

​
results
LoadbalancerSerializer · object[]
required

Objects