Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

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

connectedDomainId

string

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.


import { createClient, ApiKeyStrategy } from "@wix/sdk";
import { connectedDomainSetupInfo } from "@wix/domains";

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

async function getConnectedDomainSetupInfo(connectedDomainId) {
  const response =
    await wixClient.connectedDomainSetupInfo.getConnectedDomainSetupInfo(connectedDomainId);
}


Get connected domain setup info with an API key

getConnectedDomainSetupInfo

ConnectedDomainSetupInfo

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

or

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

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

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

domains_connected-domain-setup-info

ARecord

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.

number

values

CnameRecord

value

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

nameserverRecord

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

pointingRecords

Information about subdomains.  Available only for subdomains.

subdomainRecords

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

Information about the external domain registrar including current name
servers.

registrar

Registrar

NameserverRecord

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

nsRecord

NsRecord

PointingRecords

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

aRecord

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

cnameRecord

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

SubdomainRecords

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