DNS レコードの取得

GET

apps

{app_id}

network

dns

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

このルートを使用するには、あらかじめアプリケーションにカスタムドメインが割り当てられている必要があります。 カスタムドメインは Standard プラン以上で利用できます。このルートには10秒あたり3リクエストのレート制限があります。

string

必須

アカウントの API キーです。これはアカウント設定で確認できます。

これらは、Cloudflare がカスタムドメインの所有権を検証し SSL 証明書を発行するために必要なレコードです。通常はドメイン検証と ACME チャレンジ検証用の txt レコードが 1〜2 件と、実際にアプリケーションへトラフィックをルーティングする cname.squareweb.app を指す cname レコードで構成されます。ドメインレジストラ側でこれらのレコードを追加してください。Cloudflare が自動的にポーリングするため、再リクエストは不要です。レスポンスはオーナーおよびアプリケーションごとに 30 秒間キャッシュされ、Cubic AI エージェントがアプリケーションのドメイン設定を確認する際にも同じキャッシュが使用されます。カスタムホスト名がまだエッジに登録されていない場合、レスポンスはエラーではなく空の配列になります。カスタムドメインを新たに割り当てるには、カスタムドメインの設定を参照してください。自分のアプリケーション全体に設定されているホスト名の一覧は、ドメイン一覧の取得も参照してください。

パラメータ

string

必須

アプリケーションのID。アプリケーションのダッシュボードのURLで確認できます。

レスポンス

string

呼び出しが成功したかどうかを示します。成功した場合は success、失敗した場合は error です。

array

レスポンスの内容。

表示オブジェクトを切り替え

string

DNS レコードのタイプ。

string

DNS レコードの名前。

string

DNS レコードの値。

string

DNS レコードのステータス。pending_validation、pending、または 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"
    }
  ]
}

一般的なエラー

コード	HTTP	説明
`NO_CUSTOM_DOMAIN`	400	アプリケーションにカスタムドメインが割り当てられていません。

ウェブサイトアナリティクスSquare Cloud でホストされているウェブサイトのアナリティクスを取得します。60 秒あたり 10 件のキャッシュされていないリクエストのレート制限があります。

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

​パラメータ

​レスポンス

​一般的なエラー

パラメータ

レスポンス

一般的なエラー