Class DnsAPI

Web Hosting Dns API.

This API allows you to manage your Web Hosting services.

Hierarchy

API
- DnsAPI

Index

Constructors

Properties

Methods

checkUserOwnsDomain getDomainDnsRecords syncDomainDnsRecords

Constructors

constructor

new DnsAPI(client: Client): DnsAPI
Parameters
- client: Client
Returns DnsAPI
Inherited from ParentAPI.constructor
- Defined in packages/clients/src/scw/api.ts:9

Properties

`Static` `Readonly`LOCALITIES

LOCALITIES: Region[] = ...

Lists the available regions of the API.

Methods

checkUserOwnsDomain

checkUserOwnsDomain(
request: Readonly<DnsApiCheckUserOwnsDomainRequest>,
): Promise<Webhosting.v1.CheckUserOwnsDomainResponse>
"Check whether you own this domain or not.".
Parameters
- request: Readonly<DnsApiCheckUserOwnsDomainRequest>
  The request DnsApiCheckUserOwnsDomainRequest
Returns Promise<Webhosting.v1.CheckUserOwnsDomainResponse>
A Promise of CheckUserOwnsDomainResponse
- Defined in packages/clients/src/api/webhosting/v1/api.gen.ts:435

getDomainDnsRecords

getDomainDnsRecords(
request: Readonly<DnsApiGetDomainDnsRecordsRequest>,
): Promise<Webhosting.v1.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<Webhosting.v1.DnsRecords>
A Promise of DnsRecords
- Defined in packages/clients/src/api/webhosting/v1/api.gen.ts:420

syncDomainDnsRecords

syncDomainDnsRecords(
request: Readonly<DnsApiSyncDomainDnsRecordsRequest>,
): Promise<Webhosting.v1.DnsRecords>
"Synchronize your DNS records on the Elements Console and on cPanel.".
Parameters
- request: Readonly<DnsApiSyncDomainDnsRecordsRequest>
  The request DnsApiSyncDomainDnsRecordsRequest
Returns Promise<Webhosting.v1.DnsRecords>
A Promise of DnsRecords
- Defined in packages/clients/src/api/webhosting/v1/api.gen.ts:457