Class DnsAPI

constructor

• new DnsAPI(client: Client): DnsAPI

• Parameters

  • client: Client

  Returns DnsAPI

Static ReadonlyLOCALITIES

checkUserOwnsDomain

• checkUserOwnsDomain(
      request: Readonly<DnsApiCheckUserOwnsDomainRequest>,
  ): Promise<CheckUserOwnsDomainResponse>

• Check whether you own this domain or not.. Check whether you own this domain or not.

  Parameters

  • request: Readonly<DnsApiCheckUserOwnsDomainRequest>

    The request DnsApiCheckUserOwnsDomainRequest

  Returns Promise<CheckUserOwnsDomainResponse>

  A Promise of CheckUserOwnsDomainResponse

getDomain

• getDomain(
      request: Readonly<DnsApiGetDomainRequest>,
  ): Promise<Webhosting.v1.Domain>

• Retrieve detailed information about a specific domain, including its status, DNS configuration, and ownership.. Retrieve detailed information about a specific domain, including its status, DNS configuration, and ownership.

  Parameters

  • request: Readonly<DnsApiGetDomainRequest>

    The request DnsApiGetDomainRequest

  Returns Promise<Webhosting.v1.Domain>

  A Promise of Domain

getDomainDnsRecords

• getDomainDnsRecords(
      request: Readonly<DnsApiGetDomainDnsRecordsRequest>,
  ): Promise<DnsRecords>

• Get DNS records. Get the set of DNS records of a specified domain associated with a Web Hosting plan's domain.

  Parameters

  • request: Readonly<DnsApiGetDomainDnsRecordsRequest>

    The request DnsApiGetDomainDnsRecordsRequest

  Returns Promise<DnsRecords>

  A Promise of DnsRecords

searchDomains

• searchDomains(
      request: Readonly<DnsApiSearchDomainsRequest>,
  ): Promise<SearchDomainsResponse>

• Search for available domains based on domain name.. Search for available domains based on domain name.

  Parameters

  • request: Readonly<DnsApiSearchDomainsRequest>

    The request DnsApiSearchDomainsRequest

  Returns Promise<SearchDomainsResponse>

  A Promise of SearchDomainsResponse

syncDomainDnsRecords

• syncDomainDnsRecords(
      request: Readonly<DnsApiSyncDomainDnsRecordsRequest>,
  ): Promise<DnsRecords>

• Synchronize your DNS records on the Elements Console and on cPanel.. Synchronize your DNS records on the Elements Console and on cPanel.

  Parameters

  • request: Readonly<DnsApiSyncDomainDnsRecordsRequest>

    The request DnsApiSyncDomainDnsRecordsRequest

  Returns Promise<DnsRecords>

  A Promise of DnsRecords

waitForDomain

• waitForDomain(
      request: Readonly<DnsApiGetDomainRequest>,
      options?: Readonly<WaitForOptions<Webhosting.v1.Domain>>,
  ): Promise<Webhosting.v1.Domain>

• Waits for Domain to be in a final state.

  Parameters

  • request: Readonly<DnsApiGetDomainRequest>

    The request DnsApiGetDomainRequest
  • Optionaloptions: Readonly<WaitForOptions<Webhosting.v1.Domain>>

    The waiting options

  Returns Promise<Webhosting.v1.Domain>

  A Promise of Domain