Skip to Content

The DomainHostname type of the TypeScript SDK, part of DomainHostnameList.

type DomainHostname = {
  checkedAt: number | null
  createdAt: number | null
  directOnly: boolean
  domain: string
  hostname: string | null
  nsTargets?: string[]
  service: HostnameService
  status: HostnameCheckStatus
  target: string | null
  verifiedAt: number | null
}

Fields

FieldTypeDescription
checkedAtnumber | nullTimestamp of the most recent verification check in epoch seconds
createdAtnumber | nullTimestamp when hostname was configured in epoch seconds
directOnlybooleanTrue if CNAME must resolve directly without HTTP proxying (mail/smtp)
domainstringDomain name
hostnamestring | nullConfigured custom hostname, or null when unclaimed
nsTargetsstring[]Optional. mx only: the platform nameserver hostnames the customer must publish as NS records at the claimed name (instead of a CNAME)
serviceHostnameService
statusHostnameCheckStatus
targetstring | nullExpected CNAME target host to point DNS to (null for the NS-delegated mx service)
verifiedAtnumber | nullTimestamp when hostname was successfully verified in epoch seconds

Used in

DomainHostnameList.

On this page