Domains auflisten - Square Cloud

GET

apps

domains

Domains auflisten

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

erforderlich

Der API-Schlüssel für Ihr Konto. Sie finden ihn in Ihren Kontoeinstellungen.

Verwende diesen Endpoint, um eine einzige, kontoweite Übersicht über alle konfigurierten Hostnamen zu erhalten, nützlich, um eine Domains-Übersichtsseite zu befüllen, ohne Anwendungsinformationen abrufen einmal pro Anwendung aufzurufen. Um eine benutzerdefinierte Domain für eine bestimmte Anwendung anzuhängen oder zu ändern, siehe Benutzerdefinierte Domain festlegen; DNS-Einträge einer Domain werden separat über DNS-Einträge abrufen abgerufen.

Dieser Endpoint akzeptiert entweder Ihren API-Schlüssel oder ein Session-Token (JWT) im Authorization-Header. Authentifizierung ist erforderlich — Anfragen ohne sie geben 401 zurück.

Antwort

string

Gibt an, ob der Aufruf erfolgreich war. success bei Erfolg, error andernfalls.

Das response-Array ist eine flache Liste aller Hostnamen über die Anwendungen, die Ihnen gehören. Benutzerdefinierte Domains kommen zuerst, gefolgt von den standardmäßigen *.squareweb.app-Subdomains. Anwendungen ohne Web-Domain (z. B. Worker und Bots) werden ausgelassen.

Diese Liste wird aus der zwischengespeicherten Projektliste bereitgestellt und wird daher nicht auf die Netzwerk-Rate-Limits pro Anwendung angerechnet.

array

Die Liste der Hostnamen.

Anzeigen Objekt umschalten

string

Der 24-stellige hexadezimale Bezeichner der Anwendung, der die Domain gehört.

string

Der vollständig qualifizierte Hostname.

string

"subdomain" für den standardmäßigen *.squareweb.app-Host; "custom" für eine angehängte benutzerdefinierte Domain.

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

Zurück

Cache leerenLeert den globalen Cache der Anwendung am Edge. Hat ein Rate-Limit von 1 Anfrage alle 60 Sekunden.

Weiter

Domains auflisten

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

​Antwort

Antwort