> ## 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.

# DNS レコードの取得

> カスタムドメインの DNS レコードを取得します。

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

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

### パラメータ

<ParamField path="app_id" type="string" placeholder="Application ID" required>
  アプリケーションのID。アプリケーションのダッシュボードのURLで確認できます。
</ParamField>

### レスポンス

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

<ResponseField name="response" type="array">
  レスポンスの内容。

  <Expandable title="オブジェクトを切り替え">
    <ResponseField name="type" type="string">
      DNS レコードのタイプ。
    </ResponseField>

    <ResponseField name="name" type="string">
      DNS レコードの名前。
    </ResponseField>

    <ResponseField name="value" type="string">
      DNS レコードの値。
    </ResponseField>

    <ResponseField name="status" type="string">
      DNS レコードのステータス。`pending_validation`、`pending`、または `active` のいずれかです。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
    "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"
      }
    ]
  }
  ```
</ResponseExample>
