Get DNS Records - Square Cloud

GET

apps

{app_id}

network

dns

Get DNS Records

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

A custom domain must already be attached to the application to use this route. Custom domains are available on the Standard plan and above. This route is rate limited to 3 requests every 10 seconds.

string

required

The API key for your account. You can find this in your account settings.

These are the records Cloudflare needs to validate ownership of the custom domain and issue its SSL certificate: typically one or two txt records (domain and ACME challenge validation) plus a cname record pointing at cname.squareweb.app, which is what actually routes traffic to the application. Add them at your domain registrar; Cloudflare polls for them automatically, no re-request needed. The response is cached for 30 seconds per owner and application, and the same cache backs the Cubic AI agent when it inspects an application’s domain setup. If the custom hostname has not been registered at the edge yet, the response is an empty array rather than an error. To attach a custom domain in the first place, see Set Custom Domain. See also List Domains for every hostname configured across your applications.

Parameters

string

required

The ID of the application. You can find this in the URL of your application’s dashboard.

Response

string

Indicates whether the call was successful.. success if successful, error if not.

array

The contents of the response.

Show Toggle object

string

The type of the DNS record.

string

The name of the DNS record.

string

The value of the DNS record.

string

The status of the DNS record. It can be pending_validation, pending or 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"
    }
  ]
}

Common errors

Code	HTTP	Meaning
`NO_CUSTOM_DOMAIN`	400	The application does not have a custom domain attached.

Website AnalyticsGet analytics for a website hosted on Square Cloud. There is a rate limit of 10 uncached requests every 60 seconds.

Get DNS Records

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

​Parameters

​Response

​Common errors

Parameters

Response

Common errors