getDnsZone( )

Retrieves the DNS zone belonging to the domain from Google's Cloud DNS.

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

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Domains
SCOPE.ACCOUNT.OWNER
Manage Apps in Den Center
Manage Billing
Manage Domains
Learn more about app permissions.
Method Declaration
Copy
function getDnsZone(domainName: string): Promise<DnsZone>;
Method Parameters
domainNamestringRequired

Domain to retrieve the DNS zone for.

Returns
Return Type:Promise<DnsZone>
Get 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 getDnsZone(domainName) {
  const response = await domainDns.getDnsZone(domainName);
}
Errors

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

Did this help?