Connected Domain Object

Attributes
idstringRead-onlyformat HOSTNAME
ID of the connected domain. Identical to the domain name including TLD.

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

connectionTypestring
4 supported values:
UNKNOWN_CONNECTION_TYPEPOINTINGNAMESERVERSHIDDEN
How the domain is connected to the Wix site.
  • "UNKNOWN_CONNECTION_TYPE": There is no information about the connection type.
  • "POINTING": The domain is connected by pointing. Wix doesn't manage DNS information.
  • "NAMESERVERS": The domain is connected by nameservers. Wix manages DNS information.
  • "HIDDEN": The domain isn't visible to site visitors.

siteInfoobject
Information about the site to which the domain is assigned to and whether it's the primary domain or a redirect.

suppressNotificationsboolean
Whether the site owner receives standard email notifications from Wix about the connected domain. Default: false

dnsPropagationStatusstringRead-only
4 supported values:
UNKNOWN_DNS_PROPAGATION_STATUSCOMPLETEDFAILEDIN_PROGRESS
DNS propagation status.
  • "UNKNOWN_DNS_PROPAGATION_STATUS": There's no information about the domain's DNS propagation status.
  • "IN_PROGRESS": The domain's DNS propagation process has started but hasn't successfully completed yet.
  • "COMPLETED": The domain's DNS propagation process has successfully finished.
  • "FAILED": The domain's DNS propagation process has failed.
Was this helpful?
Yes
No

GetList Connected Domains

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 100 connected domains.

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

The retrieved domains are sorted by createdDate in descending order.

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Domains
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/domains/v1/connected-domains

Was this helpful?
Yes
No

PostCreate Connected Domain

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a connectedDomain object and starts the domain connection process. It may take up to 48 hours for the DNS changes to take effect.

You must pass the relevant Wix account ID in the header of the call. You may also pass a Wix site ID in the header.

You can only connect external domains using this endpoint. Domains purchased and billed through Wix can't be connected via this endpoint to a Wix site. For those domains use the Registered Domains API instead.

You can connect both root domains and subdomains to Wix sites.

The domain can be assigned as a primary domain or a redirect. You can read more about primary and redirected domains. If you connect a domain as "PRIMARY" to a Wix site, the existing primary domain automatically becomes unassigned.

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Domains
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/domains/v1/connected-domains

Was this helpful?
Yes
No

GetGet Connected Domain

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves 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

For app development, you must have one of the following permission scopes:
Manage Domains
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/domains/v1/connected-domains/{connectedDomainId}

Was this helpful?
Yes
No