Listar Dominios - Square Cloud

GET

apps

domains

Listar Dominios

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

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/domains', 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/domains",
  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/domains"

	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/domains")

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": [
    { "app_id": "abc123def456abc123def456", "hostname": "example.com", "type": "custom" },
    { "app_id": "abc123def456abc123def456", "hostname": "my-app.squareweb.app", "type": "subdomain" }
  ]
}

string

requerido

La clave de API de tu cuenta. Puedes encontrarla en la configuración de tu cuenta.

Usa este endpoint para obtener una vista única, a nivel de cuenta, de cada hostname que tengas configurado, útil para poblar una página de resumen de dominios sin llamar a Obtener información de la aplicación una vez por aplicación. Para asociar o cambiar un dominio personalizado en una aplicación específica, consulta Establecer dominio personalizado; los registros DNS de un dominio se obtienen por separado mediante Obtener registros DNS.

Este endpoint acepta tu clave de API o un token de sesión (JWT) en el encabezado Authorization. La autenticación es obligatoria: las solicitudes sin ella devuelven 401.

Respuesta

string

Indica si la llamada fue exitosa. success si fue exitosa, error si no.

El array response es una lista aplanada de cada hostname en las aplicaciones que posees. Los dominios personalizados aparecen primero, seguidos de los subdominios predeterminados *.squareweb.app. Las aplicaciones sin un dominio web (por ejemplo, workers y bots) se omiten.

Esta lista se sirve desde la lista de proyectos en caché, por lo que no cuenta contra los límites de solicitudes de red por aplicación.

array

La lista de hostnames.

Mostrar Alternar objeto

string

El identificador hexadecimal de 24 caracteres de la aplicación propietaria del dominio.

string

El hostname completamente cualificado.

string

"subdomain" para el host predeterminado *.squareweb.app; "custom" para un dominio personalizado asociado.

{
  "status": "success",
  "response": [
    { "app_id": "abc123def456abc123def456", "hostname": "example.com", "type": "custom" },
    { "app_id": "abc123def456abc123def456", "hostname": "my-app.squareweb.app", "type": "subdomain" }
  ]
}

Purgar cachéPurga la caché global de la aplicación en el Edge. Tiene un límite de tasa de 1 solicitud cada 60 segundos.

Listar Dominios

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

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/domains', 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/domains",
  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/domains"

	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/domains")

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": [
    { "app_id": "abc123def456abc123def456", "hostname": "example.com", "type": "custom" },
    { "app_id": "abc123def456abc123def456", "hostname": "my-app.squareweb.app", "type": "subdomain" }
  ]
}

​Respuesta

Respuesta