Replace a site's extra domains
Replaces the list of extra domains and sets whether search engines are asked not to index the site. Send the version you last read; a save that changes something answers the operation to follow.
Path parameters
The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.
Body
The complete list of extra domains to keep, each once and never the main domain. A plain hostname redirects to the primary; the object form chooses a redirect or a storefront. A site has at most 10 hostnames in total. Up to 9 items.
Fields of an item given as an object
Choose this address for the store's base URLs, at most one address per website or store view.
Defaults to redirect. A Shopware storefront serves its sales channel; a Magento 2 storefront uses store.
redirectstorefrontMagento 2 storefront aliases only. Required for a new storefront alias; omitted on an existing storefront alias, its mapping is kept. Null shows the default store. A redirect cannot carry a store choice.
True to ask search engines not to index the site.
Magento 2 only. Optional hosts whose stores' base URLs are moved here, even from another host. Each must be the primary address or a storefront alias with a Magento store, with at most one address per website or store view. Up to 10 items.
The version you last read. At least 0.
Returns
200 Nothing differs from what is saved, so nothing started. operation is null.
201 The change started. Follow operation.id.
Fields of the 200 answer
A site's domains with their DNS and certificate state.
Fields
Whether a saved set of rules is live on the site.
Fields
Sent only by the sets that have more to say, such as HTTP authentication.
The change that is applying the set, while one is running.
Such as applied or applying.
Whether your company's Cloudflare is connected, and the zone the main domain is in.
Fields
Fields of each item
The connected Cloudflare zone the hostname is in, with its id and name. proxied and record_id are sent as null.
Fields of each item
Format: date-time.
points_hereproxied_hereelsewhereunresolvedunknownThe address the hostname must point at.
True when search engines are asked not to index this hostname. Not sent in the answer of POST …/domains/point-dns.
The hostname this one redirects to. Null when it serves the site itself.
primaryaliaspreviewlegacystoreSent for extra domains on Shopware, and on Magento 2 while Magento store domains are available.
redirectstorefrontA Magento storefront alias's store choice, or the selected choice on the primary. An unmapped alias shows the default store.
Fields
While pending, the store losing this host; null for a new storefront. Omitted otherwise.
mappedpendingunmappedwebsitestorenullThe certificate for the hostname.
Fields
Format: date-time.
readypendingfailednoneThe address the site's domains must point at.
Fields
The most hostnames a site can have, the main domain included.
Why the domains cannot be changed. Null when they can.
production once a domain is attached, staging before.
productionstagingTrue when search engines are asked not to index the site.
roleflagsnoneThe main domain. Null until a domain is attached.
Fields
Whether the main domain can be changed now, and why not.
Fields
The main domain change that is running, if one is.
Send this with a save. It changes whenever the domains change. At least 0.
Whether the main domain is its www or its bare form.
The change to follow. Null when nothing differs.
Fields of the 201 answer
A site's domains with their DNS and certificate state.
Fields
Whether a saved set of rules is live on the site.
Fields
Sent only by the sets that have more to say, such as HTTP authentication.
The change that is applying the set, while one is running.
Such as applied or applying.
Whether your company's Cloudflare is connected, and the zone the main domain is in.
Fields
Fields of each item
The connected Cloudflare zone the hostname is in, with its id and name. proxied and record_id are sent as null.
Fields of each item
Format: date-time.
points_hereproxied_hereelsewhereunresolvedunknownThe address the hostname must point at.
True when search engines are asked not to index this hostname. Not sent in the answer of POST …/domains/point-dns.
The hostname this one redirects to. Null when it serves the site itself.
primaryaliaspreviewlegacystoreSent for extra domains on Shopware, and on Magento 2 while Magento store domains are available.
redirectstorefrontA Magento storefront alias's store choice, or the selected choice on the primary. An unmapped alias shows the default store.
Fields
While pending, the store losing this host; null for a new storefront. Omitted otherwise.
mappedpendingunmappedwebsitestorenullThe certificate for the hostname.
Fields
Format: date-time.
readypendingfailednoneThe address the site's domains must point at.
Fields
The most hostnames a site can have, the main domain included.
Why the domains cannot be changed. Null when they can.
production once a domain is attached, staging before.
productionstagingTrue when search engines are asked not to index the site.
roleflagsnoneThe main domain. Null until a domain is attached.
Fields
Whether the main domain can be changed now, and why not.
Fields
The main domain change that is running, if one is.
Send this with a save. It changes whenever the domains change. At least 0.
Whether the main domain is its www or its bare form.
The change to follow. Null when nothing differs.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | company_unavailable | Your company is unavailable. |
403 | scope_required | Use a token with the scope named in scope. |
403 | two_factor_required | Turn on two-factor on your account, then send again. |
404 | feature_off | This feature is not on for your organisation yet. |
409 | maintenance | The site is in maintenance mode, which blocks this. Switch maintenance mode off first. |
409 | managed_elsewhere | This site is read-only here. Change it in the control panel that manages it. |
409 | preview_only | The environment has no domain attached yet. Attach one first. |
409 | stale | What you read has changed since you read it. Read it again, then send the change with its new version or quote. |
422 | invalid | Fix the field named in field; errors says why. |
422 | store_required | This address needs a Magento store choice. Choose the Magento website or store view this address shows. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl -X PUT https://manage.corefinity.com/api/corestack/sites/1042/domains \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"aliases": [
"www.harbourandfinch.example.com",
"shop.harbourandfinch.example.com"
],
"noindex": false,
"version": 4
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->put('https://manage.corefinity.com/api/corestack/sites/1042/domains', [
'aliases' => [
'www.harbourandfinch.example.com',
'shop.harbourandfinch.example.com',
],
'noindex' => false,
'version' => 4,
]);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/domains', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
aliases: [
'www.harbourandfinch.example.com',
'shop.harbourandfinch.example.com',
],
noindex: false,
version: 4,
}),
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.put(
"https://manage.corefinity.com/api/corestack/sites/1042/domains",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={
"aliases": [
"www.harbourandfinch.example.com",
"shop.harbourandfinch.example.com",
],
"noindex": False,
"version": 4,
},
)
data = res.json() if res.content else None{
"domains": {
"advice": null,
"apply": {
"applied_at": "2026-11-02T14:37:55Z",
"error": null,
"operation": null,
"state": "applied",
"state_label": "Applied"
},
"canonical_url": "https://harbourandfinch.example.com",
"cloudflare": {
"connected": false,
"zone": null
},
"hosts": [
{
"cloudflare_zone": null,
"dns_answers": [
{
"type": "A",
"value": "203.0.113.10"
}
],
"dns_checked_at": "2026-11-06T09:16:05Z",
"dns_detail": null,
"dns_state": "points_here",
"dns_state_since": "2026-11-01T10:14:03Z",
"expected_ip": "203.0.113.10",
"host": "harbourandfinch.example.com",
"noindex": false,
"redirects_to": null,
"role": "primary",
"tls": {
"checked_at": "2026-11-06T09:14:41Z",
"issuer": "Let's Encrypt",
"not_after": "2026-12-08T05:41:17Z",
"reason": null,
"state": "ready"
}
},
{
"cloudflare_zone": null,
"dns_answers": [
{
"type": "A",
"value": "203.0.113.10"
}
],
"dns_checked_at": "2026-11-06T09:16:05Z",
"dns_detail": null,
"dns_state": "points_here",
"dns_state_since": "2026-11-01T10:14:03Z",
"expected_ip": "203.0.113.10",
"host": "www.harbourandfinch.example.com",
"noindex": false,
"redirects_to": "harbourandfinch.example.com",
"role": "alias",
"tls": {
"checked_at": "2026-11-06T09:14:41Z",
"issuer": "Let's Encrypt",
"not_after": "2026-12-08T05:41:17Z",
"reason": null,
"state": "ready"
}
}
],
"ingress_ip": "203.0.113.10",
"limits": {
"hosts_max": 10
},
"locked_reason": null,
"mode": "production",
"noindex": false,
"noindex_source": "flags",
"primary": "harbourandfinch.example.com",
"url_change": {
"can_change": {
"available": true,
"reason": null
},
"in_flight": null
},
"version": 4,
"www": "bare"
},
"operation": null
}{
"domains": {
"advice": null,
"apply": {
"applied_at": "2026-11-02T14:37:55Z",
"error": null,
"operation": {
"id": 77162,
"scope": "site",
"status": "committed",
"status_label": "Waiting for the platform",
"summary": "Alias added: shop.harbourandfinch.example.com",
"to_version": null,
"type": "domains_change",
"type_label": "Domains"
},
"state": "applying",
"state_label": "Applying"
},
"canonical_url": "https://harbourandfinch.example.com",
"cloudflare": {
"connected": false,
"zone": null
},
"hosts": [
{
"cloudflare_zone": null,
"dns_answers": [
{
"type": "A",
"value": "203.0.113.10"
}
],
"dns_checked_at": "2026-11-06T09:16:05Z",
"dns_detail": null,
"dns_state": "points_here",
"dns_state_since": "2026-11-01T10:14:03Z",
"expected_ip": "203.0.113.10",
"host": "harbourandfinch.example.com",
"noindex": false,
"redirects_to": null,
"role": "primary",
"tls": {
"checked_at": "2026-11-06T09:14:41Z",
"issuer": "Let's Encrypt",
"not_after": "2026-12-08T05:41:17Z",
"reason": null,
"state": "ready"
}
},
{
"cloudflare_zone": null,
"dns_answers": [
{
"type": "A",
"value": "203.0.113.10"
}
],
"dns_checked_at": "2026-11-06T09:16:05Z",
"dns_detail": null,
"dns_state": "points_here",
"dns_state_since": "2026-11-01T10:14:03Z",
"expected_ip": "203.0.113.10",
"host": "www.harbourandfinch.example.com",
"noindex": false,
"redirects_to": "harbourandfinch.example.com",
"role": "alias",
"tls": {
"checked_at": "2026-11-06T09:14:41Z",
"issuer": "Let's Encrypt",
"not_after": "2026-12-08T05:41:17Z",
"reason": null,
"state": "ready"
}
},
{
"cloudflare_zone": null,
"dns_answers": [
{
"type": "A",
"value": "203.0.113.10"
}
],
"dns_checked_at": "2026-11-06T09:16:05Z",
"dns_detail": null,
"dns_state": "points_here",
"dns_state_since": "2026-11-06T09:16:05Z",
"expected_ip": "203.0.113.10",
"host": "shop.harbourandfinch.example.com",
"noindex": false,
"redirects_to": "harbourandfinch.example.com",
"role": "alias",
"tls": {
"checked_at": null,
"issuer": null,
"not_after": null,
"reason": null,
"state": "pending"
}
}
],
"ingress_ip": "203.0.113.10",
"limits": {
"hosts_max": 10
},
"locked_reason": null,
"mode": "production",
"noindex": false,
"noindex_source": "flags",
"primary": "harbourandfinch.example.com",
"url_change": {
"can_change": {
"available": false,
"reason": "Another change to this site is in progress. Wait for it to finish."
},
"in_flight": null
},
"version": 5,
"www": "bare"
},
"operation": {
"applied_at": null,
"can_retry": false,
"cluster": {
"id": 1017,
"name": "Northwind UK 1"
},
"committed_at": "2026-11-06T09:17:15Z",
"completed_at": null,
"created_at": "2026-11-06T09:17:12Z",
"environment": {
"env_id": "rs-harbourandfinch-example-com",
"hostname": "harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1042,
"name": "Production",
"role": "production",
"role_label": "Production",
"slug": "production"
},
"error": null,
"failure_reason": null,
"from_version": null,
"hot": false,
"id": 77162,
"label": "Picked up by the platform",
"notes": [],
"parent_operation_id": null,
"requested_by": {
"id": 5021,
"name": "Eleanor Finch"
},
"result": null,
"result_state": "none",
"retried_by_operation_id": null,
"retries_operation_id": null,
"retry_requires": null,
"scope": "site",
"site": {
"domain": "harbourandfinch.example.com",
"id": 1042
},
"status": "committed",
"status_label": "Waiting for the platform",
"step": "applied",
"steps": [
{
"key": "saved",
"label": "Saved",
"state": "done"
},
{
"key": "applied",
"label": "Picked up by the platform",
"state": "current"
},
{
"key": "restarted",
"label": "Change applied",
"state": "todo"
},
{
"key": "healthy",
"label": "Healthy",
"state": "todo"
}
],
"summary": "Alias added: shop.harbourandfinch.example.com",
"to_version": null,
"type": "domains_change",
"type_label": "Domains"
}
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "maintenance",
"message": "Switch the maintenance page off before changing the site's hosts",
"reason": "maintenance"
}{
"code": "invalid",
"errors": {
"aliases.1": [
"Each host may appear once"
]
},
"field": "aliases.1",
"message": "Each host may appear once",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it is off for this endpointIt deletes data that cannot be brought back. Copy the request and run it yourself when you are sure.