網域

網域代表綁定到帳戶的自訂 hostname，用於品牌呈現、郵件送達與 TLS 設定。

Schema

interface Domain {
  id: string; // "hst..." - 唯一識別
  account_id: string; // 所屬帳戶
  hostname: string; // 網域名稱
  client_id: string | null; // 相關 client
  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 client
`cname_config`	`object?`	CNAME proxy 設定
`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"
}