域名
域名表示绑定到账户的自定义 hostname,用于品牌展示、邮件送达与 TLS 配置。
Schema
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 验证 token |
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"
}