DNS-Einträge abrufen - Square Cloud

GET

apps

{app_id}

network

dns

DNS-Einträge abrufen

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/network/dns \
  --header 'Authorization: <authorization>'

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

fetch('https://api.squarecloud.app/v2/apps/{app_id}/network/dns', 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/{app_id}/network/dns",
  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/{app_id}/network/dns"

	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/{app_id}/network/dns")

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": [
    {
      "type": "txt",
      "name": "_acme-challenge.joaootavios.dev",
      "value": "hmo-jMx_KCWQU5CWG6xmrkI4AOZOJXlQtjEtc7zI1PA",
      "status": "pending_validation"
    },
    {
      "type": "cname",
      "name": "joaootavios.dev",
      "value": "cname.squareweb.app",
      "status": "pending"
    }
  ]
}

Eine Custom Domain muss bereits an die Anwendung gebunden sein, um diese Route zu nutzen. Custom Domains sind ab dem Standard-Plan verfügbar. Für diese Route gilt ein Rate-Limit von 3 Anfragen alle 10 Sekunden.

string

erforderlich

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

Dies sind die Einträge, die Cloudflare benötigt, um den Besitz der Custom Domain zu validieren und ihr SSL-Zertifikat auszustellen: typischerweise ein oder zwei txt-Einträge (Domain- und ACME-Challenge-Validierung) sowie ein cname-Eintrag, der auf cname.squareweb.app verweist und der tatsächlich den Traffic zur Anwendung leitet. Füge sie bei deinem Domain-Registrar hinzu; Cloudflare fragt sie automatisch ab, eine erneute Anfrage ist nicht nötig. Die Antwort wird 30 Sekunden lang pro Eigentümer und Anwendung zwischengespeichert, und derselbe Cache wird auch vom Cubic-KI-Agenten genutzt, wenn er die Domain-Konfiguration einer Anwendung prüft. Wurde der Custom-Hostname am Edge noch nicht registriert, ist die Antwort ein leeres Array statt eines Fehlers. Um überhaupt erst eine Custom Domain anzubinden, siehe Custom Domain festlegen. Siehe auch Domains auflisten für alle über deine Anwendungen konfigurierten Hostnamen.

Parameter

string

erforderlich

Die ID der Anwendung. Du findest sie in der URL des Dashboards deiner Anwendung.

Antwort

string

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

array

Der Inhalt der Antwort.

Anzeigen Objekt umschalten

string

Der Typ des DNS-Eintrags.

string

Der Name des DNS-Eintrags.

string

Der Wert des DNS-Eintrags.

string

Der Status des DNS-Eintrags. Er kann pending_validation, pending oder active sein.

{
  "status": "success",
  "response": [
    {
      "type": "txt",
      "name": "_acme-challenge.joaootavios.dev",
      "value": "hmo-jMx_KCWQU5CWG6xmrkI4AOZOJXlQtjEtc7zI1PA",
      "status": "pending_validation"
    },
    {
      "type": "cname",
      "name": "joaootavios.dev",
      "value": "cname.squareweb.app",
      "status": "pending"
    }
  ]
}

Häufige Fehler

Code	HTTP	Bedeutung
`NO_CUSTOM_DOMAIN`	400	Die Anwendung hat keine Custom Domain angebunden.

Zurück

Website-AnalyticsAnalytics für eine auf Square Cloud gehostete Website abrufen. Es gilt ein Rate-Limit von 10 nicht zwischengespeicherten Anfragen alle 60 Sekunden.

Weiter

DNS-Einträge abrufen

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/network/dns \
  --header 'Authorization: <authorization>'

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

fetch('https://api.squarecloud.app/v2/apps/{app_id}/network/dns', 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/{app_id}/network/dns",
  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/{app_id}/network/dns"

	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/{app_id}/network/dns")

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": [
    {
      "type": "txt",
      "name": "_acme-challenge.joaootavios.dev",
      "value": "hmo-jMx_KCWQU5CWG6xmrkI4AOZOJXlQtjEtc7zI1PA",
      "status": "pending_validation"
    },
    {
      "type": "cname",
      "name": "joaootavios.dev",
      "value": "cname.squareweb.app",
      "status": "pending"
    }
  ]
}

​Parameter

​Antwort

​Häufige Fehler

Parameter

Antwort

Häufige Fehler