About the Connected Domain Setup Info API

The Connected Domain Setup Info API allows you to retrieve setup information required to connect domains that haven't been registered through Wix to a Wix site.

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 child account. This will not affect the responses to calls, which remain consistent across API keys, provided you have the necessary permissions.

Terminology

• Connected domain: A domain that's owned by an external provider, not Wix. Also called external domain.
• Registered domain: A domain that's owned by Wix and billed through Wix.
• Connection type: Information about how the domain is connected to the Wix site.
  • Nameserver: A server component of the DNS that stores human-readable domain names. With this connection type, Wix hosts your DNS, while your domain remains registered with its current host.
  • Pointing: A connection type for cases where the DNS is hosted outside of Wix. Read more about connecting a domain to Wix by pointing.
• Setup information: Information that helps site owners navigate the connection process. Includes the name of the domain's external registrar and information about DNS records.
• Reseller: Strategic partner that offers Wix services to their customers. Read more about resellers.
• 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.