Skip to main content
GET
/
v2
/
apps
/
load-balancers
List Load Balancers
curl --request GET \
  --url https://api.squarecloud.app/v2/apps/load-balancers \
  --header 'Authorization: <authorization>'
import requests

url = "https://api.squarecloud.app/v2/apps/load-balancers"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/load-balancers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/apps/load-balancers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/apps/load-balancers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/load-balancers")
  .header("Authorization", "<authorization>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/load-balancers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "response": {
    "limit": 2,
    "balancers": [
      {
        "hostname": "example.com",
        "apps": [
          { "id": "abc123def456abc123def456", "name": "web-1", "cluster": "suki-cluster" },
          { "id": "def456abc123def456abc123", "name": "web-2", "cluster": "nasa-cluster" }
        ]
      }
    ]
  }
}
Groups the account’s applications by attached custom domain. Every custom domain appears as one group with the applications serving it; a group with two or more applications is an active load balancer, where traffic is balanced across the applications at the edge with automatic failover when one is offline. Attach the same domain to multiple applications with the Set Custom Domain route.
​
Authorization
string
required
The API key for your account. You can find this in your account settings.

​
Response

​
status
string
Indicates whether the call was successful.. success if successful, error if not.
​
response
object
{
  "status": "success",
  "response": {
    "limit": 2,
    "balancers": [
      {
        "hostname": "example.com",
        "apps": [
          { "id": "abc123def456abc123def456", "name": "web-1", "cluster": "suki-cluster" },
          { "id": "def456abc123def456abc123", "name": "web-2", "cluster": "nasa-cluster" }
        ]
      }
    ]
  }
}