List Load Balancers - Square Cloud

GET

apps

load-balancers

List Load Balancers

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/load-balancers \
  --header 'Authorization: <authorization>'

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))

}

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.

string

required

The API key for your account. You can find this in your account settings.

This endpoint reads from the same cached project list used elsewhere in the API, so it does not call out to the edge provider and is not subject to the per-application network rate limits that gate Network Analytics and Network Errors. It is rate limited to 20 requests per 60 seconds per user instead. limit reflects the caller’s own plan tier (2 on Standard, 5 on Pro, 10 on Enterprise), so check it before attempting to add another application to an existing group. Attach or detach applications from a domain with Set Custom Domain, or see every hostname on the account with List Domains.

Response

string

Indicates whether the call was successful.. success if successful, error if not.

object

Hide properties

integer

Maximum number of applications allowed on one domain for the account’s plan: 2 on Standard, 5 on Pro, 10 on Enterprise.

array

Custom domains grouped by hostname. Empty array when no application has a custom domain.

Show properties

string

The custom domain.

array

Applications serving this domain (id, name, and the cluster currently hosting each).

{
  "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" }
        ]
      }
    ]
  }
}

List DomainsList all hostnames configured across your applications, including the default squareweb.app subdomain and any attached custom domain. It has a rate limit of 20 requests every 60 seconds.

List Load Balancers

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/load-balancers \
  --header 'Authorization: <authorization>'

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))

}

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" }
        ]
      }
    ]
  }
}

​Response

Response