Enregistrements DNS d'un domaine personnalisé

GET

apps

{app_id}

network

dns

Enregistrements DNS d'un domaine personnalisé

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.example.com",
      "value": "hmo-jMx_KCWQU5CWG6xmrkI4AOZOJXlQtjEtc7zI1PA",
      "status": "pending_validation"
    },
    {
      "type": "cname",
      "name": "example.com",
      "value": "cname.squareweb.app",
      "status": "pending",
      "errors": ["custom hostname does not CNAME to this zone."]
    }
  ]
}

Un domaine personnalisé doit déjà être rattaché à l’application pour utiliser cette route. Les domaines personnalisés sont disponibles à partir du plan Standard. Cette route est limitée à 3 requêtes toutes les 10 secondes.

string

requis

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

Nécessite une clé API avec le scope apps:read. Ce sont les enregistrements dont Cloudflare a besoin pour valider la propriété du domaine personnalisé et émettre son certificat SSL : généralement un ou deux enregistrements txt (validation du domaine et du challenge ACME) plus un enregistrement cname pointant vers cname.squareweb.app, qui est ce qui achemine réellement le trafic vers l’application. Ajoutez-les chez votre registraire de domaine ; Cloudflare les détecte automatiquement, aucune nouvelle requête n’est nécessaire. La réponse est mise en cache par propriétaire et par application : 150 secondes tant qu’un enregistrement est en attente, et 10 minutes une fois qu’ils sont tous actifs. Le même cache alimente l’agent Cubic AI lorsqu’il inspecte la configuration de domaine d’une application. Si l’edge ne répond pas, la réponse reprend les derniers enregistrements lus pour ce domaine. Si le nom d’hôte personnalisé n’a pas encore été enregistré au niveau de l’edge, la réponse est un tableau vide plutôt qu’une erreur. Pour rattacher un domaine personnalisé en premier lieu, voir Définir un domaine personnalisé. Voir aussi Lister les domaines pour tous les noms d’hôte configurés sur vos applications.

Paramètres

string

requis

L’ID de l’application. Vous pouvez le trouver dans l’URL du tableau de bord de votre application.

Réponse

string

Indique si l’appel a réussi : success si c’est le cas, error sinon.

array

Le contenu de la réponse.

Afficher les propriétés

string

Le type de l’enregistrement DNS.

string

Le nom de l’enregistrement DNS.

string

La valeur de l’enregistrement DNS.

string

Le statut de l’enregistrement DNS. Il peut être pending_validation, pending ou active.

string[]

Présent uniquement sur un enregistrement qui n’est pas encore active, et seulement lorsque Cloudflare a indiqué pourquoi : jusqu’à 3 messages de validation, en anglais, tels que Cloudflare les a rédigés (par exemple, le CNAME pointe ailleurs ou la valeur du TXT est introuvable). Utilisez-les pour voir ce qui ne va pas encore chez votre fournisseur DNS.

{
  "status": "success",
  "response": [
    {
      "type": "txt",
      "name": "_acme-challenge.example.com",
      "value": "hmo-jMx_KCWQU5CWG6xmrkI4AOZOJXlQtjEtc7zI1PA",
      "status": "pending_validation"
    },
    {
      "type": "cname",
      "name": "example.com",
      "value": "cname.squareweb.app",
      "status": "pending",
      "errors": ["custom hostname does not CNAME to this zone."]
    }
  ]
}

Erreurs courantes

Code	HTTP	Signification
`NO_CUSTOM_DOMAIN`	400	L’application n’a pas de domaine personnalisé rattaché.

Voir aussi

CLI : squarecloud app network dns
SDK : api.apps.network.dns() (JavaScript), client.apps.network.dns() (Python), c.Apps.Network.DNS() (Go)

Enregistrements DNS d'un domaine personnalisé

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.example.com",
      "value": "hmo-jMx_KCWQU5CWG6xmrkI4AOZOJXlQtjEtc7zI1PA",
      "status": "pending_validation"
    },
    {
      "type": "cname",
      "name": "example.com",
      "value": "cname.squareweb.app",
      "status": "pending",
      "errors": ["custom hostname does not CNAME to this zone."]
    }
  ]
}

Premiers pas

Compte

Applications

Bases de données

Workspaces

IA

Enregistrements DNS d'un domaine personnalisé

Paramètres

Réponse

Erreurs courantes

Voir aussi

​Paramètres

​Réponse

​Erreurs courantes

​Voir aussi

Paramètres

Réponse

Erreurs courantes

Voir aussi