List a cluster's load balancers

GET

/api/v1/organizations/{orgID}/clusters/{clusterID}/loadbalancers

curl --request GET \
  --url https://api.aetherplatform.cloud/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/loadbalancers \
  --header 'Authorization: Bearer <token>'

Read-only listing of load balancers provisioned for the cluster.

Authorizations

• bearerApiToken

Parameters

Path Parameters

orgID

required

string format: uuid

Organization UUID.

clusterID

required

string format: uuid

Cluster UUID.

Responses

200

A list of load balancers.

Media type application/json

object

items

required

Array<object>

A Kubernetes load-balancer Service exported from the tenant cluster. Currently returns an empty list; populated pending tenant-cluster integration.

object

service_name

required

The Kubernetes Service name.

string

namespace

required

The Kubernetes namespace containing the Service.

string

external_ip

The external IP address assigned by the load balancer (if available).

string

dns_name

The DNS name associated with the load balancer (if available).

string

ports

required

List of port numbers the load balancer is listening on.

Array<integer>

Example ^generated

{
  "items": [
    {
      "service_name": "example",
      "namespace": "example",
      "external_ip": "example",
      "dns_name": "example",
      "ports": [
        1
      ]
    }
  ]
}

401

Missing or invalid credentials.

Media type application/json

object

error

required

object

code

required

A stable, machine-readable error code.

string

message

required

string

details

Array<object>

object

field

required

string

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "field": "example",
        "code": "example",
        "message": "example"
      }
    ]
  }
}

404

The requested resource was not found.

Media type application/json

object

error

required

object

code

required

A stable, machine-readable error code.

string

message

required

string

details

Array<object>

object

field

required

string

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "field": "example",
        "code": "example",
        "message": "example"
      }
    ]
  }
}