Get to know our frameworks

Select an app template built on your preferred framework.

Build apps on our native app editor. Use drag and drop elements, Velo code and Wix APIs to develop custom features.

Streamline your app development process with the Wix CLI. Get a familiar developer experience with minimal setup and configuration.

Take full control over your app's tech stack, deployment, and hosting.

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

Kickstart your app development with templates built on your preferred Wix developer tool. Browse templates for practical foundation and get to know the Wix ecosystem.

Wix App Templates for Developers

This example apps can be used as a starting point for building your own app, for concrete examples of how to use Wix framework, or for inspiration.

Choose a template.<0 />Build an app.

Browse by:

How to build it step by step:

This template is built with:

Read how this template was built, step by step.

How we built this template

Deployment instructions:

Choose a package manager and run the command in your terminal.

Copy command

Before you get started, make sure you have the following:

Prerequisite steps

Get started with Wix CLI

Begin by setting up your Next.js project with your preferred hosting platform.

Select your hosting service

Start the deployment flow and set up your template repo on Netlify. After you finish set up, come back here and add your Netlify custom domain.

Copy the code from our Git repo to deploy your app on any platform that supports Next.js.

Start the deployment flow and set up your template repo on Vercel. After you finish set up, come back here and add your Vercel generated URL.

Add the base URL and give your app a name.

App details

Go to the app dashboard and test your app to ensure a smooth integration within the Wix ecosystem. <0>Learn more about app checks and testing</0>

Define your environment

Terminal

Related templates

Note

Warning

Your app name will be used as the namespace suffix.

Name your app to generate a namespace. This lets you refer to your app in code later on.

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

dnsZone

DnsZone

Creates a DNS zone in [Google's Cloud DNS](https://cloud.google.com/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.

import { domainDns } from '@wix/domains';

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

createDnsZone: Wix-hosted

import { createClient } from '@wix/sdk';
import { domainDns } from '@wix/domains';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { domainDns },
  // Include the auth strategy and host as relevant
});


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

Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).

createDnsZone: Self-hosted

createDnsZone

domainName

string

Deletes a DNS zone in [Google's Cloud DNS](https://cloud.google.com/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.

import { domainDns } from '@wix/domains';

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

deleteDnsZone: Wix-hosted

import { createClient } from '@wix/sdk';
import { domainDns } from '@wix/domains';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { domainDns },
  // Include the auth strategy and host as relevant
});


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

deleteDnsZone: Self-hosted

deleteDnsZone

void

Retrieves the DNS zone belonging to the domain from
[Google's Cloud DNS](https://cloud.google.com/dns).


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

import { domainDns } from '@wix/domains';

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

getDnsZone: Wix-hosted

import { createClient } from '@wix/sdk';
import { domainDns } from '@wix/domains';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { domainDns },
  // Include the auth strategy and host as relevant
});


async function getDnsZone(domainName) {
  const response = await myWixClient.domainDns.getDnsZone(domainName);
};

getDnsZone: Self-hosted

getDnsZone

Domain name to generate a DNS zone preview for.

Generates a preview for a DNS zone based on
[Google's Cloud DNS](https://cloud.google.com/dns).


This includes calculating the `A`, `CNAME`, `NS` and `SOA` records.
You can use this information to configure a domain from an external
provider, before connecting it to a Wix site.

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

import { domainDns } from '@wix/domains';

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

previewDnsZone: Wix-hosted

import { createClient } from '@wix/sdk';
import { domainDns } from '@wix/domains';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { domainDns },
  // Include the auth strategy and host as relevant
});


async function previewDnsZone(domainName) {
  const response = await myWixClient.domainDns.previewDnsZone(domainName);
};

previewDnsZone: Self-hosted

previewDnsZone

PreviewDnsZoneResponse

Domain to update the DNS zone for. Must include the TLD.

options

UpdateDnsZoneOptions

Adds DNS records to and removes DNS records from a DNS zone in
[Google's Cloud DNS](https://cloud.google.com/dns).

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. This means, you must
delete the relevant record and add a new `addition` object for this type
to the request, in case you want to add values for an existing DNS record
type.

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

import { domainDns } from '@wix/domains';

async function updateDnsZone(domainName, options) {
  const response = await domainDns.updateDnsZone(domainName, options);
};

updateDnsZone: Wix-hosted

import { createClient } from '@wix/sdk';
import { domainDns } from '@wix/domains';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { domainDns },
  // Include the auth strategy and host as relevant
});


async function updateDnsZone(domainName, options) {
  const response = await myWixClient.domainDns.updateDnsZone(domainName, options);
};

updateDnsZone: Self-hosted

updateDnsZone

UpdateDnsZoneResponse

# About the Domain DNS API

With the Domain DNS API you can manage DNS zones in
[Google's Cloud DNS](https://cloud.google.com/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:

+ Registering domains through Wix with the [Registered Domains API](https://dev.wix.com/docs/sdk/account-level-modules/domains/registered-domains/introduction)
+ Connecting external domains to Wix sites with the [Connected Domains API](https://dev.wix.com/docs/sdk/account-level-modules/domains/connected-domains/introduction)
+ Managing Wix Premium subscriptions with the [Resellers API](https://dev.wix.com/docs/sdk/account-level-modules/resellers/introduction)

## Before you begin

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

+ The Domain DNS API is accessible via API keys. You can't access this
  API with a standard Auth header. We recommend authenticating calls with an
  API key for your main account instead of using a key for the relevant
  sub-account. But the responses to calls 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](https://dev.wix.com/docs/sdk/account-level-modules/domains/domain-dns/update-dns-zone)
  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](https://en.wikipedia.org/wiki/Top-level_domain) (TLD).
  Examples for TLDs are `com`, `net`, or `org`.
+ __DNS record__: Database record in the
  [Domain Name System](https://en.wikipedia.org/wiki/Domain_Name_System) that's
  used to map a human-readable URL to an IP address.
+ __DNS zone__: A [DNS zone](https://en.wikipedia.org/wiki/DNS_zone)
  is an administrative subdivision of the DNS namespace. When you
  [Create a DNS zone](https://dev.wix.com/docs/sdk/account-level-modules/domains/domain-dns/create-dns-zone)
  the values are uploaded to
  [Google's Cloud DNS](https://cloud.google.com/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.
  + __Sub-account__: Account that's contained within another account, forming a
    hierarchical structure. The owners of the sub-account are only able to
    interact with sites that belong to the sub-account. This setup is
    particularly useful for agencies and resellers since it limits client access
    to relevant sites only.


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

or

```console
yarn add @wix/domains
```

Then import `{ domainDns }` from `@wix/domains`:

```js
import { domainDns } from '@wix/domains'
```
  

domains_domain-dns

DnsRecord

Host name. Can be a subdomain. For example, `domain.com` or
`mail.domain.com`. Equal to the domain name, except for `CNAME` records.

hostName

[Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds.

number

[DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).

+ `UNKNOWN`: Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`.
+ `A`: Address record. Most fundamental type of DNS record that indicates the IP address of a given domain.
+ `AAAA`: Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6).
+ `NS`: Name server record. Describes which server contains the actual DNS record.
+ `SOA`: [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds adminstrative information about the zone.
+ `CNAME`: [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name.
+ `MX`: MX record. Directs emails to mail servers.
+ `TXT`: [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human readable descriptions.
+ `SPF`: SPF record. Used for email authentication.
+ `SRV`: [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location.
+ `PTR`: Pointer record. Specifies which host is supported for a given IP address.
+ `NAPTR`: [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications.

type

RecordType

DNS record values. 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.

Max: 50 records

values

ID of the Dns Zone. Identical to the domain name including TLD.

Whether [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions)
are enabled.

Default: `false`

dnssecEnabled

boolean

Information about [DNSSEC](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions).
Available only if `{"dnssecEnabled": true}`.

dnssecInfo

DnssecInfo

Domain name including the TLD. Both root domains and subdomains are supported.

DNS records. 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.

Min: 2 DNS record - a DNS zone file has to have at least two required DNS records: NS and SOA records
Max: 5000 DNS records

records

Cryptographic hash of the [DNSKEY](https://cloud.google.com/dns/docs/reference/rest/v1/dnsKeys)
record that's included in the delegation signer (DS) record and ensures secure
DNSSEC validation.

digest

Unique 16-bit identifier for a [DNSKEY](https://cloud.google.com/dns/docs/reference/rest/v1/dnsKeys)
record that allows efficient DNSSEC validation in zones with multiple keys.

keyTag

DNS zone preview.

Includes calculated `A`, `CNAME`, `NS` and `SOA` records.

DNS records to add to the DNS zone.

Max: 10 additions

additions

DNS records to remove from the DNS zone.

Max: 10 deletions

deletions

Whether you want to enable or disable [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions).

Setup