Skip to Content

Check vanity hostnames status.

Re-verifies DNS CNAME and SSL certificate status for all vanity hostnames on a domain.

openemail.hostnames.check(
  domain: string,
  options?: HostnamesCheckOptions,
): ApiPromise<DomainHostnameList>

It calls POST /domains/{domain}/hostnames/check: Check vanity hostnames status in the API reference.

Example

const domainHostnameList = await openemail.hostnames.check(domain)

Arguments

ArgumentTypeDescription
domainstringCustomer domain name (e.g. example.com). The path's {domain}.

Options

The last argument, options, a HostnamesCheckOptions, takes:

OptionTypeSent asDescription
forcebooleanquery forceSet to 'true' to bypass cache and re-query live DNS and certificate status

Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).

Answer

Awaited, it is the API's JSON, DomainHostnameList. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Domain not found or not accessible to this principal
503temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description)

A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.

Types

It names these types of the API, each on a page of its own: DomainHostnameList.