> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# GetConnectedDomainSetupInfo

# Package: connectedDomains

# Namespace: ConnectedDomainSetupInfoService

# Method link: https://dev.wix.com/docs/api-reference/account-level/domains/connected-domains/connected-domain-setup-info-v1/get-connected-domain-setup-info.md

## Introduction

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.

---

## REST API

### Schema

```
 Method: getConnectedDomainSetupInfo
 Description: Retrieves information for the initial setup of a connected domain.   You must pass the relevant Wix account GUID in the header of the call.  > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
 URL: https://www.wixapis.com/domains/v1/connected-domain-setup-info/{connectedDomainId}
 Method: GET
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  connectedDomainId
 Method parameters: 
   param name: connectedDomainId | type:   none | required: true
 Return type: GetConnectedDomainSetupInfoResponse
  - name: connectedDomainSetupInfo | type: ConnectedDomainSetupInfo | description: Retrieved setup information. 
     - ONE-OF: 
        - name: nameserverRecord | type: NameserverRecord | description: Information about domains connected using nameservers. Available only for `{"connectionType": "NAMESERVERS"}`. 
           - name: nsRecord | type: NsRecord | description: Default [nameserver record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#NS). 
              - name: hostName | type: string | description: Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. 
              - name: ttl | type: integer | description: [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. 
              - name: values | type: array | description: DNS record values. 
        - name: pointingRecords | type: PointingRecords | description: Information about domains connected by pointing.  Available only for `{"connectionType": "POINTING"}`. 
           - name: aRecord | type: ARecord | description: [Address record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#A). 
              - name: hostName | type: string | description: Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. 
              - name: ttl | type: integer | description: [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. 
              - name: values | type: array | description: DNS record values. 
           - name: cnameRecord | type: CnameRecord | description: [Canonical Name record](https://en.wikipedia.org/wiki/CNAME_record). 
              - name: hostName | type: string | description: Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. 
              - name: ttl | type: integer | description: [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. 
              - name: value | type: string | description: DNS record value. 
        - name: subdomainRecords | type: SubdomainRecords | description: Information about subdomains.  Available only for subdomains. 
           - name: cnameRecords | type: array<CnameRecord> | description: [Canonical Name records](https://en.wikipedia.org/wiki/CNAME_record). 
     - name: connectedDomainId | type: string | description: GUID of the connected domain. Identical to the domain name including TLD. 
     - name: registrar | type: Registrar | description: Information about the external domain registrar including current name servers. 
        - name: name | type: string | description: Name of the external domain registrar. For subdomains it's the registrar of the root domain. 
        - name: nameServers | type: array | description: 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). 


```

### Examples

### Retrieve a connected domain setup information.
```curl
curl -X GET 'https://www.wixapis.com/domains/v1/connected-domain-setup-info/mysite.com' \
-H 'wix-account-id: <ACCOUNT_ID>' \
-H 'Authorization: <AUTH>' \
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.connectedDomains.ConnectedDomainSetupInfoService.getConnectedDomainSetupInfo(connectedDomainId)
 Description: Retrieves information for the initial setup of a connected domain.   You must pass the relevant Wix account GUID in the header of the call.  > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  connectedDomainId
 Method parameters: 
   param name: connectedDomainId | type: string | description: GUID of the connected domain to retrieve setup information for. Identical to the domain name including TLD. | required: true
 Return type: PROMISE<ConnectedDomainSetupInfo>
  - ONE-OF: 
     - name: nameserverRecord | type: NameserverRecord | description: Information about domains connected using nameservers. Available only for `{"connectionType": "NAMESERVERS"}`. 
        - name: nsRecord | type: NsRecord | description: Default [nameserver record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#NS). 
           - name: hostName | type: string | description: Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. 
           - name: ttl | type: integer | description: [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. 
           - name: values | type: array | description: DNS record values. 
     - name: pointingRecords | type: PointingRecords | description: Information about domains connected by pointing.  Available only for `{"connectionType": "POINTING"}`. 
        - name: aRecord | type: ARecord | description: [Address record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#A). 
           - name: hostName | type: string | description: Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. 
           - name: ttl | type: integer | description: [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. 
           - name: values | type: array | description: DNS record values. 
        - name: cnameRecord | type: CnameRecord | description: [Canonical Name record](https://en.wikipedia.org/wiki/CNAME_record). 
           - name: hostName | type: string | description: Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. 
           - name: ttl | type: integer | description: [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. 
           - name: value | type: string | description: DNS record value. 
     - name: subdomainRecords | type: SubdomainRecords | description: Information about subdomains.  Available only for subdomains. 
        - name: cnameRecords | type: array<CnameRecord> | description: [Canonical Name records](https://en.wikipedia.org/wiki/CNAME_record). 
  - name: connectedDomainId | type: string | description: GUID of the connected domain. Identical to the domain name including TLD. 
  - name: registrar | type: Registrar | description: Information about the external domain registrar including current name servers. 
     - name: name | type: string | description: Name of the external domain registrar. For subdomains it's the registrar of the root domain. 
     - name: nameServers | type: array | description: 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). 


```

### Examples

### getConnectedDomainSetupInfo
```javascript
import { connectedDomainSetupInfo } from '@wix/domains';

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

### getConnectedDomainSetupInfo (with elevated permissions)
```javascript
import { connectedDomainSetupInfo } from '@wix/domains';
import { auth } from '@wix/essentials';

async function myGetConnectedDomainSetupInfoMethod(connectedDomainId) {
  const elevatedGetConnectedDomainSetupInfo = auth.elevate(connectedDomainSetupInfo.getConnectedDomainSetupInfo);
  const response = await elevatedGetConnectedDomainSetupInfo(connectedDomainId);
}
```

### getConnectedDomainSetupInfo (self-hosted)
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.md).

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

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


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

---