全アプリケーションのドメイン一覧
GET /v2/apps/domains で全アプリケーションのホスト名を一覧取得します。カスタムドメインが先、次にデフォルトの squareweb.app サブドメインが、それぞれのアプリとともに返ります。
GET
全アプリケーションのドメイン一覧
apps:read スコープを持つ API キーが必要です。
このエンドポイントを使用すると、設定済みのすべてのホスト名をアカウント全体で一括して確認できます。アプリケーションごとに アプリケーション情報の取得 を呼び出すことなく、ドメイン一覧ページを構築するのに便利です。特定のアプリケーションにカスタムドメインを設定・変更するには カスタムドメインの設定 を、ドメインの DNS レコードは別途 DNS レコードの取得 を参照してください。
このエンドポイントは、
Authorization ヘッダーに API キーまたはセッショントークン(JWT)のいずれかを受け付けます。認証は必須で、認証なしのリクエストは 401 を返します。レスポンス
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。response 配列は、あなたが所有するアプリケーション全体のすべてのホスト名をフラットにまとめたリストです。カスタムドメインが先頭に並び、その後にデフォルトの *.squareweb.app サブドメインが続きます。web ドメインを持たないアプリケーション(worker や bot など)は除外されます。
このリストはキャッシュされたプロジェクト一覧から提供されるため、アプリケーションごとのネットワークレート制限にはカウントされません。
array
ホスト名のリスト。
関連項目
- CLI:
squarecloud app domains - SDK:
api.apps.domains()(JavaScript),client.apps.domains()(Python),c.Apps.Domains()(Go)

