Domaine
Un domaine représente un hostname personnalisé enregistré sur un compte pour le branding, la délivrabilité e-mail et la configuration TLS.
Schéma
interface Domain {
id: string; // "hst..." - Unique identifier
account_id: string; // Owning account
hostname: string; // Domain name
client_id: string | null; // Associated 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 record value
}Propriétés
| Propriété | Type | Description |
|---|---|---|
id |
string |
KSUID avec préfixe hst |
account_id |
string |
Compte propriétaire du domaine |
hostname |
string |
Nom de domaine (ex. mail.example.com) |
client_id |
string? |
Client OAuth associé |
cname_config |
object? |
Configuration du proxy CNAME |
email_config |
object? |
Configuration de routage des e-mails entrants |
txt_verification_token |
string |
Jeton pour la vérification TXT DNS |
Vérification DNS
Ajoutez un enregistrement TXT pour vérifier la propriété :
| Record Type | Name | Value |
|---|---|---|
| TXT | _am.mail.example.com |
{txt_verification_token} |
Flux de vérification
Exemple
{
"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"
}