ByCloud Docs
GuidesCLIAPISDK
get/v1/load-balancers

List load balancers

List all load balancers in the current organization

Query Parameters

limit

integeroptional

query

Maximum number of items to return

Default: 20

Example: 20

marker

string<uuid>optional

query

ID of the last item from the previous page (for pagination)

Example: "550e8400-e29b-41d4-a716-446655440000"

name

stringoptional

query

Filter by name (exact match or prefix with *)

Example: "web-*"

tags

stringoptional

query

Filter by tags (comma-separated)

Example: "web,production"

vip_subnet_id

string<uuid>optional

query

Filter by VIP subnet ID

vip_address

stringoptional

query

Filter by VIP address

provisioning_status

stringoptional

query

Filter by provisioning status

operating_status

stringoptional

query

Filter by operating status

Responses

200

List of load balancers

Content-Type: application/json

load_balancers

arrayoptional

meta

objectoptional

links

objectoptional
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X GET "https://api.spo1.mycloud.com/v1/load-balancers" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

Response

List of load balancers

{
  "load_balancers": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "crn": "crn:spo1:loadbalancer:load-balancer:550e8400-e29b-41d4-a716-446655440000",
      "name": "web-lb",
      "description": "Load balancer for web servers",
      "provisioning_status": "ACTIVE",
      "operating_status": "ONLINE",
      "vip_address": "192.168.1.100",
      "vip_port_id": "550e8400-e29b-41d4-a716-446655440000",
      "vip_subnet_id": "550e8400-e29b-41d4-a716-446655440001",
      "vip_network_id": "550e8400-e29b-41d4-a716-446655440002",
      "listeners": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "pools": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "provider": "octavia",
      "flavor_id": "550e8400-e29b-41d4-a716-446655440000",
      "tags": [
        "web",
        "frontend"
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 150,
    "limit": 20,
    "marker": "550e8400-e29b-41d4-a716-446655440000",
    "has_more": true
  },
  "links": {
    "self": "https://api.spo1.mycloud.com/v1/instances?limit=20",
    "next": "https://api.spo1.mycloud.com/v1/instances?limit=20&marker=550e8400-e29b-41d4-a716-446655440000",
    "previous": "https://api.spo1.mycloud.com/v1/instances?limit=20&marker=440e8400-e29b-41d4-a716-446655440000"
  }
}