{"id":"cc0bf1fd-caa5-448f-a36a-469661a7adaa","createdDate":"2024-05-07T09:19:18.850Z","updatedDate":"2024-05-07T09:19:18.850Z","resourceId":"2282e49b-a36b-48f9-8733-0b4eecdef7e9","api":{"schema":{"object":{"displayName":"Dns Zone Object","description":"DNS zones hold information about the records that map a domain's URL to an IP address.","slug":"dns-zone-object","$ref":"#/components/schemas/com.wixpress.premium.domain.dns.DnsZone","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/premium.git"},"methods":[{"summary":"Create Dns Zone","description":"Creates a DNS zone in [Google's Cloud DNS](https://cloud.google.com/dns).\n\n\nIf there is an existing DNS zone for the domain, it's deleted before\nthe new zone is created.\n\nThe call is synchronous, that means it fails in case of an error on\nGoogle's side.\n\nYou can only set up a single `record` object per DNS record\ntype. If you want to specify multiple values for the same record type, you\nmust save them in the `values` for the relevant type.\n\n> __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.","operationId":"com.wixpress.premium.domain.dns.DomainDns.CreateDnsZone","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.premium.domain.dns.CreateDnsZoneResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/domains/v1/dns-zones","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/domains/v1/dns-zones","destinationPath":"/v1/dns-zones","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateDnsZoneRequest","description":"","properties":{"dnsZone":{"description":"DNS zone to create.","$ref":"#/components/schemas/com.wixpress.premium.domain.dns.DnsZone","summary":"dnsZone","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["dnsZone","dnsZone.domainName","dnsZone.records.type","dnsZone.records.hostName"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.premium.domain.dns.DomainDns","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["DOMAINS.MANAGE_DNS_ZONES"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.premium.domain.dns:domain-dns","serviceArtifactId":"com.wixpress.premium.domain.dns.domain-dns","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.premium.domain.dns.CreateDnsZoneRequest","responseMessage":"com.wixpress.premium.domain.dns.CreateDnsZoneResponse"},"legacyExamples":[{"name":"CreateDnsZone","type":"METHOD","content":{"title":"Create a DNS zone.","request":"curl -X POST\n'https://www.wixapis.com/domains/v1/dns-zones' \\\n-H 'wix-account-id: ' \\\n-H 'Authorization: ' \\\n-d '{\n \"dnsZone\": {\n \"records\": [\n {\n \"values\": [\n \"10 aspmx.l.google.com\"\n ],\n \"ttl\": 3600,\n \"hostName\": \"mysite.com\",\n \"type\": \"MX\"\n }\n ],\n \"domainName\": \"mysite.com\"\n }\n}'","response":"{\n \"dnsZone\": {\n \"records\": [\n {\n \"values\": [\n \"10 aspmx.l.google.com\"\n ],\n \"ttl\": 3600,\n \"hostName\": \"mysite.com\",\n \"type\": \"MX\"\n }\n ],\n \"domainName\": \"mysite.com\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/premium.git"},"httpMethod":"post","path":"/v1/dns-zones","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.premium.domain.dns.DomainDns","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["DOMAINS.MANAGE_DNS_ZONES"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.premium.domain.dns:domain-dns","serviceArtifactId":"com.wixpress.premium.domain.dns.domain-dns","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.premium.domain.dns.CreateDnsZoneRequest","responseMessage":"com.wixpress.premium.domain.dns.CreateDnsZoneResponse"},"legacyExamples":[{"name":"CreateDnsZone","type":"METHOD","content":{"title":"Create a DNS zone.","request":"curl -X POST\n'https://www.wixapis.com/domains/v1/dns-zones' \\\n-H 'wix-account-id: ' \\\n-H 'Authorization: ' \\\n-d '{\n \"dnsZone\": {\n \"records\": [\n {\n \"values\": [\n \"10 aspmx.l.google.com\"\n ],\n \"ttl\": 3600,\n \"hostName\": \"mysite.com\",\n \"type\": \"MX\"\n }\n ],\n \"domainName\": \"mysite.com\"\n }\n}'","response":"{\n \"dnsZone\": {\n \"records\": [\n {\n \"values\": [\n \"10 aspmx.l.google.com\"\n ],\n \"ttl\": 3600,\n \"hostName\": \"mysite.com\",\n \"type\": \"MX\"\n }\n ],\n \"domainName\": \"mysite.com\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/premium.git","contentLink":{"displayName":"Create Dns Zone","slugifiedName":"create-dns-zone"}},{"summary":"Get Dns Zone","description":"Retrieves the DNS zone belonging to the domain from\n[Google's Cloud DNS](https://cloud.google.com/dns).\n\n\n> __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.","operationId":"com.wixpress.premium.domain.dns.DomainDns.GetDnsZone","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"domainName","description":"Domain to retrieve the DNS zone for.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.premium.domain.dns.GetDnsZoneResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/domains/v1/dns-zones","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/domains/v1/dns-zones","destinationPath":"/v1/dns-zones","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.premium.domain.dns.DomainDns","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["DOMAINS.READ_DNS_ZONES"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.premium.domain.dns:domain-dns","serviceArtifactId":"com.wixpress.premium.domain.dns.domain-dns","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.premium.domain.dns.GetDnsZoneRequest","responseMessage":"com.wixpress.premium.domain.dns.GetDnsZoneResponse"},"legacyExamples":[{"name":"GetDnsZone","type":"METHOD","content":{"title":"Retrieve a DNS zone.","request":"curl -X GET\n'https://www.wixapis.com/domains/v1/dns-zones/mysite.com' \\\n-H 'wix-account-id: ' \\\n-H 'Authorization: ' \\","response":"{\n \"dnsZone\": {\n \"records\": [\n {\n \"values\": [\n \"10 aspmx.l.google.com\"\n ],\n \"ttl\": 3600,\n \"hostName\": \"mysite.com\",\n \"type\": \"MX\"\n }\n ],\n \"domainName\": \"mysite.com\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/premium.git"},"httpMethod":"get","path":"/v1/dns-zones/{domainName}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.premium.domain.dns.DomainDns","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["DOMAINS.READ_DNS_ZONES"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.premium.domain.dns:domain-dns","serviceArtifactId":"com.wixpress.premium.domain.dns.domain-dns","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.premium.domain.dns.GetDnsZoneRequest","responseMessage":"com.wixpress.premium.domain.dns.GetDnsZoneResponse"},"legacyExamples":[{"name":"GetDnsZone","type":"METHOD","content":{"title":"Retrieve a DNS zone.","request":"curl -X GET\n'https://www.wixapis.com/domains/v1/dns-zones/mysite.com' \\\n-H 'wix-account-id: ' \\\n-H 'Authorization: ' \\","response":"{\n \"dnsZone\": {\n \"records\": [\n {\n \"values\": [\n \"10 aspmx.l.google.com\"\n ],\n \"ttl\": 3600,\n \"hostName\": \"mysite.com\",\n \"type\": \"MX\"\n }\n ],\n \"domainName\": \"mysite.com\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/premium.git","contentLink":{"displayName":"Get Dns Zone","slugifiedName":"get-dns-zone"}},{"summary":"Delete Dns Zone","description":"Deletes a DNS zone in [Google's Cloud DNS](https://cloud.google.com/dns).\n\n\nThe call is synchronous, that means it fails in case of an error on\nGoogle's side.\n\n> __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.","operationId":"com.wixpress.premium.domain.dns.DomainDns.DeleteDnsZone","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"domainName","description":"Domain name to delete the DNS zone for.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.premium.domain.dns.DeleteDnsZoneResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/domains/v1/dns-zones","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/domains/v1/dns-zones","destinationPath":"/v1/dns-zones","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.premium.domain.dns.DomainDns","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["DOMAINS.MANAGE_DNS_ZONES"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.premium.domain.dns:domain-dns","serviceArtifactId":"com.wixpress.premium.domain.dns.domain-dns","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.premium.domain.dns.DeleteDnsZoneRequest","responseMessage":"com.wixpress.premium.domain.dns.DeleteDnsZoneResponse"},"legacyExamples":[{"name":"DeleteDnsZone","type":"METHOD","content":{"title":"Delete a DNS zone.","request":"curl -X DELETE\n'https://www.wixapis.com/domains/v1/dns-zones/mysite.com' \\\n-H 'wix-account-id: ' \\\n-H 'Authorization: ' \\","response":"{\n}"}}],"sourceRepo":"git@github.com:wix-private/premium.git"},"httpMethod":"delete","path":"/v1/dns-zones/{domainName}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.premium.domain.dns.DomainDns","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["DOMAINS.MANAGE_DNS_ZONES"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.premium.domain.dns:domain-dns","serviceArtifactId":"com.wixpress.premium.domain.dns.domain-dns","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.premium.domain.dns.DeleteDnsZoneRequest","responseMessage":"com.wixpress.premium.domain.dns.DeleteDnsZoneResponse"},"legacyExamples":[{"name":"DeleteDnsZone","type":"METHOD","content":{"title":"Delete a DNS zone.","request":"curl -X DELETE\n'https://www.wixapis.com/domains/v1/dns-zones/mysite.com' \\\n-H 'wix-account-id: ' \\\n-H 'Authorization: ' \\","response":"{\n}"}}],"sourceRepo":"git@github.com:wix-private/premium.git","contentLink":{"displayName":"Delete Dns Zone","slugifiedName":"delete-dns-zone"}},{"summary":"Update Dns Zone","description":"Adds DNS records to and removes DNS records from a DNS zone in\n[Google's Cloud DNS](https://cloud.google.com/dns).\n\nThe call is synchronous, that means it fails in case of an error on\nGoogle's side.\n\nYou can only set up a single `record` object per DNS record\ntype. If you want to specify multiple values for the same record type, you\nmust save them in the `values` for the relevant type. This means, you must\ndelete the relevant record and add a new `addition` object for this type\nto the request, in case you want to add values for an existing DNS record\ntype.\n\n> __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.","operationId":"com.wixpress.premium.domain.dns.DomainDns.UpdateDnsZone","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"domainName","description":"Domain to update the DNS zone for. Must include the TLD.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.premium.domain.dns.UpdateDnsZoneResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/domains/v1/dns-zones","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/domains/v1/dns-zones","destinationPath":"/v1/dns-zones","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateDnsZoneRequest","description":"","properties":{"additions":{"description":"DNS records to add to the DNS zone.\n\nMax: 10 additions","maxItems":10,"title":"additions","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.premium.domain.dns.DnsRecord"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletions":{"description":"DNS records to remove from the DNS zone.\n\nMax: 10 deletions","maxItems":10,"title":"deletions","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.premium.domain.dns.DnsRecord"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dnssecEnabled":{"description":"Whether you want to enable or disable [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions).","title":"dnssecEnabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["domainName","additions.type","additions.hostName","deletions.type","deletions.hostName"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.premium.domain.dns.DomainDns","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["DOMAINS.MANAGE_DNS_ZONES"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.premium.domain.dns:domain-dns","serviceArtifactId":"com.wixpress.premium.domain.dns.domain-dns","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.premium.domain.dns.UpdateDnsZoneRequest","responseMessage":"com.wixpress.premium.domain.dns.UpdateDnsZoneResponse"},"legacyExamples":[{"name":"UpdateDnsZone","type":"METHOD","content":{"title":"Update a DNS zone.","request":"curl -X PATCH\n'https://www.wixapis.com/domains/v1/dns-zones/mysite.com' \\\n-H 'wix-account-id: ' \\\n-H 'Authorization: ' \\\n-d '{\n \"deletions\": [\n {\n \"values\": \"google-site-verification=epsWybsHVqJqkw0dD2xrIaSO_jYJAmczAU7IqLWToVM\",\n \"type\": \"TXT\",\n \"hostName\": \"mysite.com\",\n \"ttl\": 3600\n }\n ],\n \"additions\": [\n {\n \"values\": \"10 aspmx.l.google.com\",\n \"type\": \"MX\",\n \"hostName\": \"mysite.com\",\n \"ttl\": 3600\n }\n ],\n \"domainName\": \"mysite.com\"\n}'","response":"{\n \"dnsZone\": {\n \"records\": [\n {\n \"values\": [\n \"10 aspmx.l.google.com\"\n ],\n \"ttl\": 3600,\n \"hostName\": \"mysite.com\",\n \"type\": \"MX\"\n }\n ],\n \"domainName\": \"mysite.com\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/premium.git"},"httpMethod":"patch","path":"/v1/dns-zones/{domainName}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.premium.domain.dns.DomainDns","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["DOMAINS.MANAGE_DNS_ZONES"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.premium.domain.dns:domain-dns","serviceArtifactId":"com.wixpress.premium.domain.dns.domain-dns","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.premium.domain.dns.UpdateDnsZoneRequest","responseMessage":"com.wixpress.premium.domain.dns.UpdateDnsZoneResponse"},"legacyExamples":[{"name":"UpdateDnsZone","type":"METHOD","content":{"title":"Update a DNS zone.","request":"curl -X PATCH\n'https://www.wixapis.com/domains/v1/dns-zones/mysite.com' \\\n-H 'wix-account-id: ' \\\n-H 'Authorization: ' \\\n-d '{\n \"deletions\": [\n {\n \"values\": \"google-site-verification=epsWybsHVqJqkw0dD2xrIaSO_jYJAmczAU7IqLWToVM\",\n \"type\": \"TXT\",\n \"hostName\": \"mysite.com\",\n \"ttl\": 3600\n }\n ],\n \"additions\": [\n {\n \"values\": \"10 aspmx.l.google.com\",\n \"type\": \"MX\",\n \"hostName\": \"mysite.com\",\n \"ttl\": 3600\n }\n ],\n \"domainName\": \"mysite.com\"\n}'","response":"{\n \"dnsZone\": {\n \"records\": [\n {\n \"values\": [\n \"10 aspmx.l.google.com\"\n ],\n \"ttl\": 3600,\n \"hostName\": \"mysite.com\",\n \"type\": \"MX\"\n }\n ],\n \"domainName\": \"mysite.com\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/premium.git","contentLink":{"displayName":"Update Dns Zone","slugifiedName":"update-dns-zone"}},{"summary":"Preview Dns Zone","description":"Generates a preview for a DNS zone based on\n[Google's Cloud DNS](https://cloud.google.com/dns).\n\n\nThis includes calculating the `A`, `CNAME`, `NS` and `SOA` records.\nYou can use this information to configure a domain from an external\nprovider, before connecting it to a Wix site.\n\n> __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.","operationId":"com.wixpress.premium.domain.dns.DomainDns.PreviewDnsZone","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"domainName","description":"Domain name to generate a DNS zone preview for.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.premium.domain.dns.PreviewDnsZoneResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/domains/v1/dns-zones","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/domains/v1/dns-zones","destinationPath":"/v1/dns-zones","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.premium.domain.dns.DomainDns","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["DOMAINS.READ_DNS_ZONES"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.premium.domain.dns:domain-dns","serviceArtifactId":"com.wixpress.premium.domain.dns.domain-dns","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.premium.domain.dns.PreviewDnsZoneRequest","responseMessage":"com.wixpress.premium.domain.dns.PreviewDnsZoneResponse"},"legacyExamples":[{"name":"PreviewDnsZone","type":"METHOD","content":{"title":"Preview a DNS zone.","request":"curl -X GET \n'https://www.wixapis.com/domains/v1/dns-zones/mysite.com/preview' \\\n-H 'wix-account-id: ' \\\n-H 'Authorization: ' \\","response":"{\n \"dnsZone\": {\n \"records\": [\n {\n \"values\": [\n \"10 aspmx.l.google.com\"\n ],\n \"ttl\": 3600,\n \"hostName\": \"mysite.com\",\n \"type\": \"MX\"\n }\n ],\n \"domainName\": \"mysite.com\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/premium.git"},"httpMethod":"get","path":"/v1/dns-zones/{domainName}/preview","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.premium.domain.dns.DomainDns","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["DOMAINS.READ_DNS_ZONES"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.premium.domain.dns:domain-dns","serviceArtifactId":"com.wixpress.premium.domain.dns.domain-dns","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.premium.domain.dns.PreviewDnsZoneRequest","responseMessage":"com.wixpress.premium.domain.dns.PreviewDnsZoneResponse"},"legacyExamples":[{"name":"PreviewDnsZone","type":"METHOD","content":{"title":"Preview a DNS zone.","request":"curl -X GET \n'https://www.wixapis.com/domains/v1/dns-zones/mysite.com/preview' \\\n-H 'wix-account-id: ' \\\n-H 'Authorization: ' \\","response":"{\n \"dnsZone\": {\n \"records\": [\n {\n \"values\": [\n \"10 aspmx.l.google.com\"\n ],\n \"ttl\": 3600,\n \"hostName\": \"mysite.com\",\n \"type\": \"MX\"\n }\n ],\n \"domainName\": \"mysite.com\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/premium.git","contentLink":{"displayName":"Preview Dns Zone","slugifiedName":"preview-dns-zone"}}],"webhooks":[],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Domain DNS API\n\nWith the Domain DNS API you can manage DNS zones in\n[Google's Cloud DNS](fallback::https://cloud.google.com/dns). This allows you to connect\ndomains that you've registered through Wix to non-Wix websites. You can also use\nthe Domain DNS API to manage DNS records for external domains that are connected\nby nameservers to Wix sites.\n\nUsing the Domain DNS API you can:\n\n+ Preview DNS zones\n+ Manage DNS zones in Google's Cloud DNS\n\nLearn more about:\n\n+ Registering domains through Wix with the [Registered Domains API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8c2a0eda-61a0-45d5-aa74-cd791eae0857*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/registered-domains/introduction)\n+ Connecting external domains to Wix sites with the [Connected Domains API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::98fcf075-2739-4ef7-b0b3-4d2b69e8b2f8*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/connected-domains/introduction)\n+ Managing Wix Premium subscriptions with the [Resellers API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::15ea2c15-6765-48f0-a1e0-ecbbefaba4f7*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/resellers/introduction)\n\n## Before you begin\n\nIt’s important to note the following points before starting to code:\n\n+ The Domain DNS API is accessible via API keys. You can't access this\n API with a standard Auth header. We recommend authenticating calls with an\n API key for your main account instead of using a key for the relevant\n sub-account. But the responses to calls remain consistent across API\n keys, provided you have the necessary permissions.\n+ Wix limits DNS records to 50 values per type. External providers may support\n a different maximum number of DNS records for a specific type, Wix doesn't\n validate that you don't exceed these external limits.\n+ You can only [update DNS zones](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fcae363e-7d82-4df4-8c2e-6e9bdaf0bcc7slug::update-dns-zone*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/domain-dns/update-dns-zone)\n for external domains that are connected by nameservers to a Wix site. You\n can't use the Domain DNS API for external domains that are connected by\n pointing to a Wix site because the DNS isn't saved in Wix for this connection\n type.\n\n## Use cases\n\n+ [Update DNS records for a registered domain](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fcae363e-7d82-4df4-8c2e-6e9bdaf0bcc7slug::sample-flows#update-dns-records-for-a-registered-domain*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/domain-dns/sample-flows#update-dns-records-for-a-registered-domain)\n+ [Connect an external domain by nameservers to a Wix site](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fcae363e-7d82-4df4-8c2e-6e9bdaf0bcc7slug::sample-flows#connect-an-external-domain-by-nameservers-to-a-wix-site*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/domain-dns/sample-flows#connect-an-external-domain-by-nameservers-to-a-wix-site)\n\n## Terminology\n\n+ __Registered domain__: Domain that's purchased, registered, and billed through Wix.\n+ __External domain__: Domain that has been purchased through an external provider, not Wix.\n+ __Domain name__: The domain name includes the\n [top-level domain](fallback::https://en.wikipedia.org/wiki/Top-level_domain) (TLD).\n Examples for TLDs are `com`, `net`, or `org`.\n+ __DNS record__: Database record in the\n [Domain Name System](fallback::https://en.wikipedia.org/wiki/Domain_Name_System) that's\n used to map a human-readable URL to an IP address.\n+ __DNS zone__: A [DNS zone](fallback::https://en.wikipedia.org/wiki/DNS_zone)\n is an administrative subdivision of the DNS namespace. When you\n [Create a DNS zone](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fcae363e-7d82-4df4-8c2e-6e9bdaf0bcc7slug::create-dns-zone*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/domain-dns/create-dns-zone)\n the values are uploaded to\n [Google's Cloud DNS](fallback::https://cloud.google.com/dns).\n+ __Account__: Wix account that includes access to associated sites.\n + __Team account__: Account type that supports collaborative work by having\n multiple sets of login credentials. This is especially helpful for agencies\n and resellers when managing a large number of customer sites. In Wix Studio\n team accounts are called workspaces. An agency may have multiple workspaces\n in Wix Studio, while in Wix Editor they're limited to a single team account.\n + __Sub-account__: Account that's contained within another account, forming a\n hierarchical structure. The owners of the sub-account are only able to\n interact with sites that belong to the sub-account. This setup is\n particularly useful for agencies and resellers since it limits client access\n to relevant sites only.","sourceRepo":"git@github.com:wix-private/premium.git","path":"proto/docs/PublicIntro.md"},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Sample Use Cases & Flows: Domain DNS\n\nThis article shares a possible use case your implementation could support, as\nwell as a sample flow. You're not limited to this use case, but it can be a\nhelpful jumping off point for your planning.\n\n## Update DNS records for a registered domain\n\nYou could purchase a domain through Wix and then update the MX and TXT records.\nThis allows you to connect the domain to a website that isn't build on Wix.\n\nTo update the DNS records for a registered domain:\n\n1. Optional: In case the relevant site is a free Wix site, use the\n [Resellers API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fa07fab0-5daa-471e-ba80-727e944bb2dbslug::create-package-v2*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/resellers/packages-and-product-instances/create-package-v2)\n to assign a Premium plan to it. Make sure to save the `productInstanceId`.\n1. Use the [Resellers API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fa07fab0-5daa-471e-ba80-727e944bb2dbslug::create-package-v2*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/resellers/packages-and-product-instances/create-package-v2)\n to create a product instance for the relevant domain TLD and privacy. Don't\n assign the product instance to a site, but keep it floating in the relevant\n account.\n1. Call [Create Registered Domain](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::3bcedc58-9190-4d70-b785-538b975d1b6eslug::create-registered-domain*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/registered-domains/registered-domain-v1/create-registered-domain)\n to start the domain registration process through Wix.\n1. Use [Get Registered Domain](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::3bcedc58-9190-4d70-b785-538b975d1b6eslug::get-registered-domain*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/registered-domains/registered-domain-v1/get-registered-domain)\n to confirm that the `status` has changed to `\"PENDING_REGISTRATION\"`.\n1. Call [Update Dns Zone](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fcae363e-7d82-4df4-8c2e-6e9bdaf0bcc7slug::update-dns-zone*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/domain-dns/update-dns-zone)\n to change the MX and TXT records in Google's Cloud DNS.\n1. Connect the domain to the external site.\n\n## Connect an external domain by nameservers to a Wix site\n\nYou could help Wix site owners connect an external domain by nameservers to\ntheir site. Note that you can't use\n[Update DNS Zone](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fcae363e-7d82-4df4-8c2e-6e9bdaf0bcc7slug::update-dns-zone*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/domain-dns/update-dns-zone)\nfor external domains that are connected by pointing.\n\nTo connect an external domain by nameservers to a Wix site:\n\n1. Optional: In case the relevant site is a free Wix site, use the\n [Resellers API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fa07fab0-5daa-471e-ba80-727e944bb2dbslug::create-package-v2*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/resellers/packages-and-product-instances/create-package-v2)\n to assign a Premium plan to it.\n1. Register the domain through an external provider.\n1. Call [Create Connected Domain](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::c60e3f19-693f-4074-be19-9a3ac84d8ce3slug::create-connected-domain*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/connected-domains/connected-domain-v1/create-connected-domain)\n to start the connection process. Make sure to use\n `{\"connectionType\": \"NAMESERVERS\"}`.\n1. Use [Get Connected Domain Setup Info](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::f3849277-90ac-48d6-9d6c-3a34088ae0d2slug::connected-domain-setup-info-object*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/connected-domains/connected-domain-setup-info-v1/connected-domain-setup-info-object)\n to retrieve the new DNS record values. You find them in\n `connectedDomainSetupInfo.pointingRecords.aRecord.values`\n and `connectedDomainSetupInfo.pointingRecords.cnameRecord.value`.\n1. Use [Update Dns Zone](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fcae363e-7d82-4df4-8c2e-6e9bdaf0bcc7slug::update-dns-zone*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/domain-dns/update-dns-zone)\n to change the A and CNAME records in Google's Cloud DNS.\n1. Call [Get Connected Domain](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::c60e3f19-693f-4074-be19-9a3ac84d8ce3slug::get-connected-domain*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/connected-domains/connected-domain-v1/get-connected-domain)\n to monitor the connected domain's `dnsPropagationStatus` and confirm that it\n changes to `\"COMPLETED\"`.","sourceRepo":"git@github.com:wix-private/premium.git","path":"proto/docs/Flows.md"},{"displayName":"Error Messages","slugifyName":"error-messages","content":"# Domain DNS Errors\n\nThis articles outlines error messages that might be issued when calling\nendpoints of the Domain DNS API.\n\n## Create DNS Zone Errors\n\n[Create DNS Zone](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fcae363e-7d82-4df4-8c2e-6e9bdaf0bcc7slug::create-dns-zone*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/domain-dns/create-dns-zone) might issue the following error messages:\n\n|

HTTP status

Error code

Error message

Troubleshooting

HTTP status

Error code

Error message

Troubleshooting

|\n|---|---|---|---|\n| `NOT_FOUND (404)` | `USER_ID_NOT_FOUND` | User id not found in request context. | Make sure to pass the correct authorization header. |\n| `NOT_FOUND (404)` | `TARGET_ACCOUNT_NOT_FOUND` | Target account id not found in request context. | Make sure to pass the correct account ID in the header of the call. |\n| `FAILED_PRECONDITION (428)` | `DOMAIN_NOT_PERMITTED` | Domain `` is not permitted to target account. | Make sure to pass the correct account ID in the header of the call. The target account must also have a Premium subscription that allows connecting a domain with the chosen TLD. See the [Resellers API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::15ea2c15-6765-48f0-a1e0-ecbbefaba4f7*fallback::https://dev.wix.com/api/rest/account-level-apis/resellers/introduction) for more information. |\n| `FAILED_PRECONDITION (428)` | `DOMAIN_DNS_EMPTY_RECORD_VALUE` | Value of record `` is empty. | You must pass at least one value for each DNS record type that you want to specify in Google's Cloud DNS. |\n| `FAILED_PRECONDITION (428)` | `DOMAIN_MX_RECORD_VALUE_INVALID` | Value of MX record `` is invalid, it should start with a priority and then the mail server, for example `\"5 aspmx.l.google.com\"`. | Make sure to use this format: `\"5 aspmx.l.google.com\"`, when specifying the value of an MX record in Google's Cloud DNS. |\n| `FAILED_PRECONDITION (428)` | `DOMAIN_CNAME_RECORD_HOSTNAME_INVALID` | Host name of the CNAME record `$value` is invalid, it should end with the domain name but not equal to it, for example `\"en.domain.com\"`. | Make sure to use this format: `\"en.domain.com\"`, when specifying the value of a CNAME record in Google's Cloud DNS. |\n| `FAILED_PRECONDITION (428)` | `DOMAIN_MX_RECORD_VALUE_INVALID` | Multiple `` records with the same hostName `` not supported, the multiple values belong to the same hostName should be combined under one ``. | Make sure that you pass all DNS record values that belong to the same DNS record type in the `values` array of the relevant `record` object. You can't pass multiple `record` objects that have the same record `type`. |","sourceRepo":"git@github.com:wix-private/premium.git","path":"proto/docs/Errors.md"}],"components":{"schemas":{"com.wixpress.premium.domain.dns.DnsZone":{"type":"object","properties":{"domainName":{"description":"Domain name including the TLD. Both root domains and subdomains are supported.","format":"HOSTNAME","title":"domainName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"records":{"description":"DNS records. You can only set up a single `record` object per DNS record\ntype. If you want to specify multiple values for the same record type, you\nmust save them in the `values` for the relevant type.\n\nMin: 1 DNS record\nMax: 10 DNS records","minItems":1,"maxItems":10,"title":"records","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.premium.domain.dns.DnsRecord"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"id":{"description":"ID of the Dns Zone. Identical to the domain name including TLD.","format":"HOSTNAME","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dnssecEnabled":{"description":"Whether [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions) are enabled.\n\nDefault: `false`","title":"dnssecEnabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DnsZone","description":"DNS zones hold information about the records that map a domain's URL to an IP address."},"com.wixpress.premium.domain.dns.DnsRecord":{"type":"object","properties":{"type":{"description":"[DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).\n\n+ `UNKNOWN`: Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`.\n+ `A`: Address record. Most fundamental type of DNS record that indicates the IP address of a given domain.\n+ `AAAA`: Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6).\n+ `NS`: Name server record. Describes which server contains the actual DNS record.\n+ `SOA`: [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds adminstrative information about the zone.\n+ `CNAME`: [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name.\n+ `MX`: MX record. Directs emails to mail servers.\n+ `TXT`: [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human readable descriptions.\n+ `SPF`: SPF record. Used for email authentication.\n+ `SRV`: [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location.\n+ `PTR`: Pointer record. Specifies which host is supported for a given IP address.\n+ `NAPTR`: [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications.","title":"type","type":"string","$ref":"#/components/schemas/com.wixpress.premium.domain.dns.DnsRecord.RecordType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hostName":{"description":"Host name. Can be a subdomain. For example, `domain.com` or\n`mail.domain.com`. Equal to the domain name, except for `CNAME` records.","maxLength":256,"title":"hostName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ttl":{"description":"[Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds.","title":"ttl","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"values":{"description":"DNS record values. Wix limits DNS records to 50 values per type. External\nproviders may support a different maximum number of DNS records for a\nspecific type, Wix doesn't validate that you don't exceed these external\nlimits.\n\nMax: 50 records","minItems":1,"maxItems":50,"maxLength":1000,"title":"values","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DnsRecord","description":""},"com.wixpress.premium.domain.dns.DnsRecord.RecordType":{"type":"string","description":"","title":"RecordType","enum":["UNKNOWN","A","AAAA","NS","SOA","CNAME","MX","TXT","SPF","SRV","PTR","NAPTR"]},"com.wixpress.domains.common.proto.DomainRemovedEvent":{"type":"object","properties":{"domain":{"description":"Domain name including TLD.\nBoth root domains and subdomains are supported.","format":"HOSTNAME","title":"domain","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainRemovedEvent","description":""},"com.wixpress.premium.domain.dns.CreateDnsZoneRequest":{"type":"object","properties":{"dnsZone":{"description":"DNS zone to create.","$ref":"#/components/schemas/com.wixpress.premium.domain.dns.DnsZone","summary":"dnsZone","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateDnsZoneRequest","description":""},"com.wixpress.premium.domain.dns.CreateDnsZoneResponse":{"type":"object","properties":{"dnsZone":{"description":"Created DNS zone.","$ref":"#/components/schemas/com.wixpress.premium.domain.dns.DnsZone","summary":"dnsZone","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateDnsZoneResponse","description":""},"com.wixpress.premium.domain.dns.GetDnsZoneRequest":{"type":"object","properties":{"domainName":{"description":"Domain to retrieve the DNS zone for.","format":"HOSTNAME","title":"domainName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetDnsZoneRequest","description":""},"com.wixpress.premium.domain.dns.GetDnsZoneResponse":{"type":"object","properties":{"dnsZone":{"description":"Retrieved DNS zone.","$ref":"#/components/schemas/com.wixpress.premium.domain.dns.DnsZone","summary":"dnsZone","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetDnsZoneResponse","description":""},"com.wixpress.premium.domain.dns.UpdateDnsZoneRequest":{"type":"object","properties":{"domainName":{"description":"Domain to update the DNS zone for. Must include the TLD.","format":"HOSTNAME","title":"domainName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"additions":{"description":"DNS records to add to the DNS zone.\n\nMax: 10 additions","maxItems":10,"title":"additions","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.premium.domain.dns.DnsRecord"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletions":{"description":"DNS records to remove from the DNS zone.\n\nMax: 10 deletions","maxItems":10,"title":"deletions","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.premium.domain.dns.DnsRecord"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dnssecEnabled":{"description":"Whether you want to enable or disable [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions).","title":"dnssecEnabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateDnsZoneRequest","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"com.wixpress.premium.domain.dns.UpdateDnsZoneResponse":{"type":"object","properties":{"dnsZone":{"description":"Updated DNS zone.","$ref":"#/components/schemas/com.wixpress.premium.domain.dns.DnsZone","summary":"dnsZone","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateDnsZoneResponse","description":""},"com.wixpress.premium.domain.dns.DeleteDnsZoneRequest":{"type":"object","properties":{"domainName":{"description":"Domain name to delete the DNS zone for.","format":"HOSTNAME","title":"domainName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteDnsZoneRequest","description":""},"com.wixpress.premium.domain.dns.DeleteDnsZoneResponse":{"type":"object","properties":{},"title":"DeleteDnsZoneResponse","description":""},"com.wixpress.premium.domain.dns.PreviewDnsZoneRequest":{"type":"object","properties":{"domainName":{"description":"Domain name to generate a DNS zone preview for.","format":"HOSTNAME","title":"domainName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PreviewDnsZoneRequest","description":""},"com.wixpress.premium.domain.dns.PreviewDnsZoneResponse":{"type":"object","properties":{"dnsZone":{"description":"DNS zone preview.\n\nIncludes calculated `A`, `CNAME`, `NS` and `SOA` records.","$ref":"#/components/schemas/com.wixpress.premium.domain.dns.DnsZone","summary":"dnsZone","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PreviewDnsZoneResponse","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp.","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"Dns Zone","description":"DNS zones hold information about the records that map a domain's URL to an IP address.","fqdn":"wix.premium.domains.v1.dns_zone"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Domain DNS API\n\nWith the Domain DNS API you can manage DNS zones in\n[Google's Cloud DNS](fallback::https://cloud.google.com/dns). This allows you to connect\ndomains that you've registered through Wix to non-Wix websites. You can also use\nthe Domain DNS API to manage DNS records for external domains that are connected\nby nameservers to Wix sites.\n\nUsing the Domain DNS API you can:\n\n+ Preview DNS zones\n+ Manage DNS zones in Google's Cloud DNS\n\nLearn more about:\n\n+ Registering domains through Wix with the [Registered Domains API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8c2a0eda-61a0-45d5-aa74-cd791eae0857*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/registered-domains/introduction)\n+ Connecting external domains to Wix sites with the [Connected Domains API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::98fcf075-2739-4ef7-b0b3-4d2b69e8b2f8*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/connected-domains/introduction)\n+ Managing Wix Premium subscriptions with the [Resellers API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::15ea2c15-6765-48f0-a1e0-ecbbefaba4f7*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/resellers/introduction)\n\n## Before you begin\n\nIt’s important to note the following points before starting to code:\n\n+ The Domain DNS API is accessible via API keys. You can't access this\n API with a standard Auth header. We recommend authenticating calls with an\n API key for your main account instead of using a key for the relevant\n sub-account. But the responses to calls remain consistent across API\n keys, provided you have the necessary permissions.\n+ Wix limits DNS records to 50 values per type. External providers may support\n a different maximum number of DNS records for a specific type, Wix doesn't\n validate that you don't exceed these external limits.\n+ You can only [update DNS zones](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fcae363e-7d82-4df4-8c2e-6e9bdaf0bcc7slug::update-dns-zone*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/domain-dns/update-dns-zone)\n for external domains that are connected by nameservers to a Wix site. You\n can't use the Domain DNS API for external domains that are connected by\n pointing to a Wix site because the DNS isn't saved in Wix for this connection\n type.\n\n## Use cases\n\n+ [Update DNS records for a registered domain](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fcae363e-7d82-4df4-8c2e-6e9bdaf0bcc7slug::sample-flows#update-dns-records-for-a-registered-domain*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/domain-dns/sample-flows#update-dns-records-for-a-registered-domain)\n+ [Connect an external domain by nameservers to a Wix site](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fcae363e-7d82-4df4-8c2e-6e9bdaf0bcc7slug::sample-flows#connect-an-external-domain-by-nameservers-to-a-wix-site*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/domain-dns/sample-flows#connect-an-external-domain-by-nameservers-to-a-wix-site)\n\n## Terminology\n\n+ __Registered domain__: Domain that's purchased, registered, and billed through Wix.\n+ __External domain__: Domain that has been purchased through an external provider, not Wix.\n+ __Domain name__: The domain name includes the\n [top-level domain](fallback::https://en.wikipedia.org/wiki/Top-level_domain) (TLD).\n Examples for TLDs are `com`, `net`, or `org`.\n+ __DNS record__: Database record in the\n [Domain Name System](fallback::https://en.wikipedia.org/wiki/Domain_Name_System) that's\n used to map a human-readable URL to an IP address.\n+ __DNS zone__: A [DNS zone](fallback::https://en.wikipedia.org/wiki/DNS_zone)\n is an administrative subdivision of the DNS namespace. When you\n [Create a DNS zone](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fcae363e-7d82-4df4-8c2e-6e9bdaf0bcc7slug::create-dns-zone*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/domain-dns/create-dns-zone)\n the values are uploaded to\n [Google's Cloud DNS](fallback::https://cloud.google.com/dns).\n+ __Account__: Wix account that includes access to associated sites.\n + __Team account__: Account type that supports collaborative work by having\n multiple sets of login credentials. This is especially helpful for agencies\n and resellers when managing a large number of customer sites. In Wix Studio\n team accounts are called workspaces. An agency may have multiple workspaces\n in Wix Studio, while in Wix Editor they're limited to a single team account.\n + __Sub-account__: Account that's contained within another account, forming a\n hierarchical structure. The owners of the sub-account are only able to\n interact with sites that belong to the sub-account. This setup is\n particularly useful for agencies and resellers since it limits client access\n to relevant sites only."},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Sample Use Cases & Flows: Domain DNS\n\nThis article shares a possible use case your implementation could support, as\nwell as a sample flow. You're not limited to this use case, but it can be a\nhelpful jumping off point for your planning.\n\n## Update DNS records for a registered domain\n\nYou could purchase a domain through Wix and then update the MX and TXT records.\nThis allows you to connect the domain to a website that isn't build on Wix.\n\nTo update the DNS records for a registered domain:\n\n1. Optional: In case the relevant site is a free Wix site, use the\n [Resellers API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fa07fab0-5daa-471e-ba80-727e944bb2dbslug::create-package-v2*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/resellers/packages-and-product-instances/create-package-v2)\n to assign a Premium plan to it. Make sure to save the `productInstanceId`.\n1. Use the [Resellers API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fa07fab0-5daa-471e-ba80-727e944bb2dbslug::create-package-v2*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/resellers/packages-and-product-instances/create-package-v2)\n to create a product instance for the relevant domain TLD and privacy. Don't\n assign the product instance to a site, but keep it floating in the relevant\n account.\n1. Call [Create Registered Domain](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::3bcedc58-9190-4d70-b785-538b975d1b6eslug::create-registered-domain*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/registered-domains/registered-domain-v1/create-registered-domain)\n to start the domain registration process through Wix.\n1. Use [Get Registered Domain](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::3bcedc58-9190-4d70-b785-538b975d1b6eslug::get-registered-domain*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/registered-domains/registered-domain-v1/get-registered-domain)\n to confirm that the `status` has changed to `\"PENDING_REGISTRATION\"`.\n1. Call [Update Dns Zone](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fcae363e-7d82-4df4-8c2e-6e9bdaf0bcc7slug::update-dns-zone*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/domain-dns/update-dns-zone)\n to change the MX and TXT records in Google's Cloud DNS.\n1. Connect the domain to the external site.\n\n## Connect an external domain by nameservers to a Wix site\n\nYou could help Wix site owners connect an external domain by nameservers to\ntheir site. Note that you can't use\n[Update DNS Zone](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fcae363e-7d82-4df4-8c2e-6e9bdaf0bcc7slug::update-dns-zone*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/domain-dns/update-dns-zone)\nfor external domains that are connected by pointing.\n\nTo connect an external domain by nameservers to a Wix site:\n\n1. Optional: In case the relevant site is a free Wix site, use the\n [Resellers API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fa07fab0-5daa-471e-ba80-727e944bb2dbslug::create-package-v2*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/resellers/packages-and-product-instances/create-package-v2)\n to assign a Premium plan to it.\n1. Register the domain through an external provider.\n1. Call [Create Connected Domain](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::c60e3f19-693f-4074-be19-9a3ac84d8ce3slug::create-connected-domain*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/connected-domains/connected-domain-v1/create-connected-domain)\n to start the connection process. Make sure to use\n `{\"connectionType\": \"NAMESERVERS\"}`.\n1. Use [Get Connected Domain Setup Info](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::f3849277-90ac-48d6-9d6c-3a34088ae0d2slug::connected-domain-setup-info-object*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/connected-domains/connected-domain-setup-info-v1/connected-domain-setup-info-object)\n to retrieve the new DNS record values. You find them in\n `connectedDomainSetupInfo.pointingRecords.aRecord.values`\n and `connectedDomainSetupInfo.pointingRecords.cnameRecord.value`.\n1. Use [Update Dns Zone](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fcae363e-7d82-4df4-8c2e-6e9bdaf0bcc7slug::update-dns-zone*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/domain-dns/update-dns-zone)\n to change the A and CNAME records in Google's Cloud DNS.\n1. Call [Get Connected Domain](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::c60e3f19-693f-4074-be19-9a3ac84d8ce3slug::get-connected-domain*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/connected-domains/connected-domain-v1/get-connected-domain)\n to monitor the connected domain's `dnsPropagationStatus` and confirm that it\n changes to `\"COMPLETED\"`."},{"displayName":"Error Messages","slugifyName":"error-messages","content":"# Domain DNS Errors\n\nThis articles outlines error messages that might be issued when calling\nendpoints of the Domain DNS API.\n\n## Create DNS Zone Errors\n\n[Create DNS Zone](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fcae363e-7d82-4df4-8c2e-6e9bdaf0bcc7slug::create-dns-zone*fallback::https://dev.wix.com/docs/rest/api-reference/account-level-apis/domain-dns/create-dns-zone) might issue the following error messages:\n\n|

HTTP status

Error code

Error message

Troubleshooting

HTTP status

Error code

Error message

Troubleshooting