ドメイン
ドメインは、ブランディング、メール配信、TLS設定のためにアカウントに登録されたカスタムhostnameを表します。
スキーマ
interface Domain {
id: string; // "hst..." - 一意の識別子
account_id: string; // 所有アカウント
hostname: string; // ドメイン名
client_id: string | null; // 関連クライアント
cname_config: { type: "proxy" } | null;
email_config:
| { type: "catch-all" }
| { type: "forward"; forward_to: Record<string, string> }
| null;
txt_verification_token: string; // DNS TXT検証トークン
}
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
id | string | hst プレフィックスのKSUID |
account_id | string | ドメインの所有アカウント |
hostname | string | ドメイン名(例: mail.example.com) |
client_id | string? | 関連OAuthクライアント |
cname_config | object? | CNAMEプロキシ設定 |
email_config | object? | 受信メールのルーティング設定 |
txt_verification_token | string | DNS TXT検証トークン |
DNS検証
所有権を確認するためにTXTレコードを追加します。
| 種類 | 名前 | 値 |
|---|---|---|
| TXT | _am.mail.example.com | {txt_verification_token} |
検証フロー
例
{
"id": "hst_2kHfPZcN9xW4mE8RtY7vB",
"account_id": "acc_1jGePYbM8wV3lD7QsX6uA",
"hostname": "mail.example.com",
"client_id": null,
"cname_config": { "type": "proxy" },
"email_config": null,
"txt_verification_token": "am_2abc123xyz"
}