ドメイン一覧の取得

GET

apps

domains

ドメイン一覧の取得

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/domains \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/domains', 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/domains",
  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/domains"

	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/domains")

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": [
    { "app_id": "abc123def456abc123def456", "hostname": "example.com", "type": "custom" },
    { "app_id": "abc123def456abc123def456", "hostname": "my-app.squareweb.app", "type": "subdomain" }
  ]
}

string

必須

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

このエンドポイントを使用すると、設定済みのすべてのホスト名をアカウント全体で一括して確認できます。アプリケーションごとにアプリケーション情報の取得を呼び出すことなく、ドメイン一覧ページを構築するのに便利です。特定のアプリケーションにカスタムドメインを設定・変更するにはカスタムドメインの設定を、ドメインの DNS レコードは別途 DNS レコードの取得を参照してください。

このエンドポイントは、Authorization ヘッダーに API キーまたはセッショントークン（JWT）のいずれかを受け付けます。認証は必須で、認証なしのリクエストは 401 を返します。

レスポンス

string

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

response 配列は、あなたが所有するアプリケーション全体のすべてのホスト名をフラットにまとめたリストです。カスタムドメインが先頭に並び、その後にデフォルトの *.squareweb.app サブドメインが続きます。web ドメインを持たないアプリケーション（worker や bot など）は除外されます。

このリストはキャッシュされたプロジェクト一覧から提供されるため、アプリケーションごとのネットワークレート制限にはカウントされません。

array

ホスト名のリスト。

表示オブジェクトを表示

string

ドメインを所有するアプリケーションの 24 文字の 16 進数識別子。

string

完全修飾ホスト名。

string

デフォルトの *.squareweb.app ホストの場合は "subdomain"、割り当てられたカスタムドメインの場合は "custom"。

{
  "status": "success",
  "response": [
    { "app_id": "abc123def456abc123def456", "hostname": "example.com", "type": "custom" },
    { "app_id": "abc123def456abc123def456", "hostname": "my-app.squareweb.app", "type": "subdomain" }
  ]
}

キャッシュのパージエッジ上にあるアプリケーションのグローバルキャッシュをパージします。レート制限は 60 秒あたり 1 リクエストです。

ドメイン一覧の取得

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/domains \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/domains', 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/domains",
  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/domains"

	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/domains")

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": [
    { "app_id": "abc123def456abc123def456", "hostname": "example.com", "type": "custom" },
    { "app_id": "abc123def456abc123def456", "hostname": "my-app.squareweb.app", "type": "subdomain" }
  ]
}

​レスポンス

レスポンス