Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

GraphQL (Alpha)

Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain.

hostName

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

values

ARecord

value

CnameRecord

A `connectedDomainSetupInfo` object holds information the connected domain's
external registrar and some DNS records. You can use this information to guide
the site owner through the domain's setup process.

ID of the connected domain. Identical to the domain name including TLD.

connectedDomainId

Information about the external domain registrar including current name
servers.

ConnectedDomainSetupInfo

Information about domains connected using nameservers. Available only for
`{"connectionType": "NAMESERVERS"}`.

Information about domains connected by pointing.  Available only for
`{"connectionType": "POINTING"}`.

Information about subdomains.  Available only for subdomains.

dnsRecords

ID of the connected domain to retrieve setup information for.
Identical to the domain name including TLD.

GetConnectedDomainSetupInfoRequest

GetConnectedDomainSetupInfoResponse

Information about domains connected by nameservers.

Default [nameserver record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#NS).

NameserverRecord

NsRecord

Information about domains connected by pointing.

[Address record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#A).

[Canonical Name record](https://en.wikipedia.org/wiki/CNAME_record).

PointingRecords

Name of the external domain registrar. For subdomains it's the registrar of the root domain.

name

Values of the current name server records. In case you connect an external
domain using name servers, site owners must replace these current name servers
with the new name servers found in `connectedDomainSetupInfo.nameserverRecord.nsRecord.values`
during the initial domain setup.
The replacement can't be performed through Wix APIs, you must use the
infrastructure of the external domain registrar. Read more about
[connecting domains using nameservers](https://dev.wix.com/api/rest/account-level-apis/connected-domains/sample-flows#account-level-apis_connected-domains_sample-flows_connect-an-external-domain-using-nameservers).

nameServers

Registrar

[Canonical Name records](https://en.wikipedia.org/wiki/CNAME_record).

cnameRecords

SubdomainRecords

StringValue

Retrieves information for the initial setup of a connected domain.


You must pass the relevant Wix account ID in the header of the call.

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

Permission Scopes