Obter registros DNS - Square Cloud

GET

apps

{app_id}

network

dns

Obter registros DNS

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

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/network/dns"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

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))

}

HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/{app_id}/network/dns")
  .header("Authorization", "<authorization>")
  .asString();

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

É necessário ter um domínio personalizado já vinculado à aplicação para usar esta rota. Domínios personalizados estão disponíveis a partir do plano Standard. Esta rota possui limite de taxa de 3 requisições a cada 10 segundos.

Authorization

string

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

Esses são os registros que o Cloudflare precisa para validar a propriedade do domínio personalizado e emitir seu certificado SSL: normalmente um ou dois registros txt (validação do domínio e do desafio ACME) mais um registro cname apontando para cname.squareweb.app, que é o que efetivamente roteia o tráfego para a aplicação. Adicione-os no registrador do seu domínio; o Cloudflare verifica automaticamente, sem necessidade de nova solicitação. A resposta fica em cache por 30 segundos por proprietário e aplicação, e o mesmo cache serve o agente de IA Cubic quando ele inspeciona a configuração de domínio de uma aplicação. Se o hostname personalizado ainda não tiver sido registrado na borda, a resposta é um array vazio em vez de um erro. Para associar um domínio personalizado antes de tudo, veja Configurar domínio personalizado. Veja também Listar domínios para todos os hostnames configurados nas suas aplicações.

Parâmetros

app_id

string

obrigatório

O ID da aplicação. Você pode encontrá-lo na URL do painel da sua aplicação.

Resposta

status

string

Indica se a chamada foi bem-sucedida. success se bem-sucedida, error se não.

response

array

O conteúdo da resposta.

Mostrar Alternar objeto

type

string

O tipo do registro DNS.

name

string

O nome do registro DNS.

value

string

O valor do registro DNS.

status

string

O status do registro DNS. Pode ser pending_validation, pending ou 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"
    }
  ]
}

Erros comuns

Código	HTTP	Significado
`NO_CUSTOM_DOMAIN`	400	A aplicação não possui um domínio personalizado associado.

Análise do websiteObter análises de um website hospedado na Square Cloud. Há um limite de taxa de 10 requisições não-cached a cada 60 segundos.

Obter registros DNS

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

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/network/dns"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

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))

}

HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/{app_id}/network/dns")
  .header("Authorization", "<authorization>")
  .asString();

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

​Resposta

​Erros comuns

Parâmetros

Resposta

Erros comuns