Lister les domaines - Square Cloud

GET

apps

domains

Lister les domaines

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

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

Utilisez cet endpoint pour obtenir une vue unique et globale de tous les noms d’hôte configurés sur votre compte, utile pour construire une page de vue d’ensemble des domaines sans appeler Obtenir les infos de l’application pour chaque application. Pour attacher ou modifier un domaine personnalisé sur une application spécifique, consultez Définir un domaine personnalisé ; les enregistrements DNS d’un domaine sont récupérés séparément via Obtenir les enregistrements DNS.

Cet endpoint accepte soit votre clé d’API, soit un jeton de session (JWT) dans l’en-tête Authorization. L’authentification est obligatoire : les requêtes sans authentification renvoient 401.

Réponse

string

Indique si l’appel a réussi. success en cas de succès, error sinon.

Le tableau response est une liste aplatie de tous les noms d’hôte des applications que vous possédez. Les domaines personnalisés apparaissent en premier, suivis des sous-domaines *.squareweb.app par défaut. Les applications sans domaine web (par exemple les workers et les bots) sont omises.

Cette liste est servie depuis la liste de projets en cache, elle n’est donc pas décomptée des limites de débit réseau par application.

array

La liste des noms d’hôte.

Afficher Afficher l'objet

string

L’identifiant hexadécimal de 24 caractères de l’application qui possède le domaine.

string

Le nom d’hôte pleinement qualifié.

string

"subdomain" pour l’hôte *.squareweb.app par défaut ; "custom" pour un domaine personnalisé attaché.

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

Purger le cachePurgez le cache global de l'application sur l'Edge. Soumis à une limite de débit de 1 requête toutes les 60 secondes.

Lister les domaines

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

​Réponse

Réponse