About the Domain DNS API

With the Domain DNS API you can manage DNS zones in Google's Cloud DNS. This allows you to connect domains that you've registered through Wix to non-Wix websites. You can also use the Domain DNS API to manage DNS records for external domains that are connected by nameservers to Wix sites.

Using the Domain DNS API you can:

  • Preview DNS zones
  • Manage DNS zones in Google's Cloud DNS

Learn more about:

Before you begin

It’s important to note the following points before starting to code:

  • We recommend authenticating calls with an API key for your main account instead of using a key for the relevant sub-account. This will not affect the responses to calls, which remain consistent across API keys, provided you have the necessary permissions.
  • Wix limits DNS records to 50 values per type. External providers may support a different maximum number of DNS records for a specific type, Wix doesn't validate that you don't exceed these external limits.
  • You can only update DNS zones for external domains that are connected by nameservers to a Wix site. You can't use the Domain DNS API for external domains that are connected by pointing to a Wix site because the DNS isn't saved in Wix for this connection type.

Terminology

  • Registered domain: Domain that's purchased, registered, and billed through Wix.
  • External domain: Domain that has been purchased through an external provider, not Wix.
  • Domain name: The domain name includes the top-level domain (TLD). Examples for TLDs are com, net, or org.
  • DNS record: Database record in the Domain Name System that's used to map a human-readable URL to an IP address.
  • DNS zone: A DNS zone is an administrative subdivision of the DNS namespace. When you Create a DNS zone the values are uploaded to Google's Cloud DNS.
  • Account: Wix account that includes access to associated sites.
    • Team account: Account type that supports collaborative work by having multiple sets of login credentials. This is especially helpful for agencies and resellers when managing a large number of customer sites. In Wix Studio team accounts are called workspaces. An agency may have multiple workspaces in Wix Studio, while in Wix Editor they're limited to a single team account.
    • Child account: Account that's contained within another account, forming a hierarchical structure. The owners of the child account are only able to interact with sites that belong to the child account. This setup is particularly useful for agencies and resellers since it limits client access to relevant sites only.
Did this help?

Setup

To use the DomainDns API, install the @wix/domains package using npm or Yarn:

Copy
npm install @wix/domains

or

Copy
yarn add @wix/domains

Then import { domainDns } from @wix/domains:

Copy
import { domainDns } from "@wix/domains";
Did this help?

createDnsZone( )

Creates a DNS zone in Google's Cloud DNS.

If there is an existing DNS zone for the domain, it's deleted before the new zone is created.

The call is synchronous, that means it fails in case of an error on Google's side.

You can only set up a single record object per DNS record type. If you want to specify multiple values for the same record type, you must save them in the values for the relevant type.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header.

Method Declaration
Copy
function createDnsZone(dnsZone: DnsZone): Promise<DnsZone>;
Method Parameters
dnsZoneDnsZoneRequired

DNS zone to create.

Returns
Return Type:Promise<DnsZone>
Create a DNS zone with an API Key
JavaScript
import { createClient, ApiKeyStrategy } from "@wix/sdk";
import { domainDns } from "@wix/domains";

const wixClient = createClient({
  modules: { domainDns },
  auth: ApiKeyStrategy({
    siteId: "MY-SITE-ID",
    apiKey: "MY-API-KEY",
  }),
});

async function createDnsZone(dnsZone) {
  const response = await domainDns.createDnsZone(dnsZone);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

deleteDnsZone( )

Deletes a DNS zone in Google's Cloud DNS.

The call is synchronous, that means it fails in case of an error on Google's side.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header.

Method Declaration
Copy
function deleteDnsZone(domainName: string): Promise<void>;
Method Parameters
domainNamestringRequired

Domain name to delete the DNS zone for.

Delete a DNS zone with an API Key
JavaScript
import { createClient, ApiKeyStrategy } from "@wix/sdk";
import { domainDns } from "@wix/domains";

const wixClient = createClient({
  modules: { domainDns },
  auth: ApiKeyStrategy({
    siteId: "MY-SITE-ID",
    apiKey: "MY-API-KEY",
  }),
});

async function deleteDnsZone(domainName) {
  const response = await domainDns.deleteDnsZone(domainName);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?