Obtener registros DNS - Square Cloud

GET

apps

{app_id}

network

dns

Obtener registros DNS

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

Ya debe haber un dominio personalizado asociado a la aplicación para usar esta ruta. Los dominios personalizados están disponibles a partir del plan Standard. Esta ruta tiene un límite de 3 solicitudes cada 10 segundos.

string

requerido

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

Estos son los registros que Cloudflare necesita para validar la propiedad del dominio personalizado y emitir su certificado SSL: normalmente uno o dos registros txt (validación de dominio y de desafío ACME) más un registro cname que apunta a cname.squareweb.app, que es lo que realmente enruta el tráfico hacia la aplicación. Agrégalos en tu registrador de dominios; Cloudflare los consulta automáticamente, no es necesario volver a solicitarlos. La respuesta se almacena en caché durante 30 segundos por propietario y aplicación, y esa misma caché respalda al agente Cubic AI cuando inspecciona la configuración de dominio de una aplicación. Si el hostname personalizado aún no se ha registrado en el borde, la respuesta es un arreglo vacío en lugar de un error. Para asociar un dominio personalizado en primer lugar, consulta Establecer dominio personalizado. Consulta también Listar dominios para ver todos los hostnames configurados en tus aplicaciones.

Parámetros

string

requerido

El ID de la aplicación. Puedes encontrarlo en la URL del panel de tu aplicación.

Respuesta

string

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

array

El contenido de la respuesta.

Mostrar Alternar objeto

string

El tipo del registro DNS.

string

El nombre del registro DNS.

string

El valor del registro DNS.

string

El estado del registro DNS. Puede ser pending_validation, pending o active.

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

Errores comunes

Código	HTTP	Significado
`NO_CUSTOM_DOMAIN`	400	La aplicación no tiene un dominio personalizado asociado.

Analíticas del sitio webObtén analíticas de un sitio web alojado en Square Cloud. Hay un límite de tasa de 10 solicitudes sin caché cada 60 segundos.

Obtener registros DNS

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

​Parámetros

​Respuesta

​Errores comunes

Parámetros

Respuesta

Errores comunes