Skip to Content

The DomainHostnameList type of the TypeScript SDK, which hostnames.list and 2 more methods take or answer.

type DomainHostnameList = {
  canClaim: boolean
  domain: string
  hostnames: DomainHostname[]
}

Fields

FieldTypeDescription
canClaimbooleanTrue if this account plan permits claiming vanity hostnames
domainstringDomain name
hostnamesDomainHostname[]Custom hostname configurations for every service slot

Used by

MethodWhat it does
hostnames.listGet vanity hostnames for domain
hostnames.setConfigure vanity hostname
hostnames.checkCheck vanity hostnames status

On this page