> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# ドメイン一覧の取得

> デフォルトの squareweb.app サブドメインと、割り当てられたカスタムドメインを含む、すべてのアプリケーションに設定されたホスト名を一覧取得します。60 秒あたり 20 リクエストのレート制限があります。

<ParamField header="Authorization" type="string" placeholder="API Key" required>
  アカウントの API キーです。これは[アカウント設定](https://squarecloud.app/ja/account/security)で確認できます。
</ParamField>

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

### レスポンス

<ResponseField name="status" type="string">
  呼び出しが成功したかどうかを示します。成功した場合は `success`、失敗した場合は `error` です。
</ResponseField>

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

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

<ResponseField name="response" type="array">
  ホスト名のリスト。

  <Expandable title="オブジェクトを表示">
    <ResponseField name="app_id" type="string">
      ドメインを所有するアプリケーションの 24 文字の 16 進数識別子。
    </ResponseField>

    <ResponseField name="hostname" type="string">
      完全修飾ホスト名。
    </ResponseField>

    <ResponseField name="type" type="string">
      デフォルトの `*.squareweb.app` ホストの場合は `"subdomain"`、割り当てられたカスタムドメインの場合は `"custom"`。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
    "status": "success",
    "response": [
      { "app_id": "abc123def456abc123def456", "hostname": "example.com", "type": "custom" },
      { "app_id": "abc123def456abc123def456", "hostname": "my-app.squareweb.app", "type": "subdomain" }
    ]
  }
  ```
</ResponseExample>