Check a domain before attaching it
Answers whether every hostname is ready to attach and what is missing. blockers lists what would refuse the attach whatever DNS says. Nothing changes.
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 hostname the site answers on. One of hosts.
The Magento store shown on the primary; omitted or null uses Magento's default.
Every hostname to attach, each once. On production they must include the site's domain or its www form; on another environment they must not. Up to 10 items.
For each extra domain on Shopware or Magento 2, redirect or storefront. Each Magento storefront needs an entry in stores.
redirectstorefrontMagento 2 only. Every key is a hostname in hosts with serve set to storefront; every such hostname needs an entry. One base_url address can be chosen per website or store view.
Must match canonical. Left out, it follows canonical.
wwwbareReturns
200 The check.
Fields of the 200 answer
What refuses the attach whatever DNS says, with the reason and message the attach would answer.
Fields of each item
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.
readypendingfailednoneTrue when the hostname is ready.
What to fix, in plain words. Empty when ok is true.
True when every hostname is ready.
The environment's own address on the platform.
The address the attach would produce.
Each hostname behind Cloudflare that the check cannot look behind. Empty when there is none.
Fields of each item
Whether the certificate check gets through Cloudflare. note says what to change when it does not. ok is null when the check could not tell.
Fields
True when the certificate check gets through and the TXT record is found.
The TXT record that proves the hostname is yours.
Fields
Format: date-time.
The environment's role, such as production or staging.
wwwbareIf 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 | managed_elsewhere | This site is read-only here. Change it in the control panel that manages it. |
422 | invalid | Fix the field named in field; errors says why. |
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 POST https://manage.corefinity.com/api/corestack/sites/1042/attach-domain/check \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"canonical": "www.harbourandfinch.example.org",
"hosts": [
"harbourandfinch.example.org",
"www.harbourandfinch.example.org"
],
"www": "www"
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->post('https://manage.corefinity.com/api/corestack/sites/1042/attach-domain/check', [
'canonical' => 'www.harbourandfinch.example.org',
'hosts' => [
'harbourandfinch.example.org',
'www.harbourandfinch.example.org',
],
'www' => 'www',
]);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/attach-domain/check', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
canonical: 'www.harbourandfinch.example.org',
hosts: [
'harbourandfinch.example.org',
'www.harbourandfinch.example.org',
],
www: 'www',
}),
});
// 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.post(
"https://manage.corefinity.com/api/corestack/sites/1042/attach-domain/check",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={
"canonical": "www.harbourandfinch.example.org",
"hosts": [
"harbourandfinch.example.org",
"www.harbourandfinch.example.org",
],
"www": "www",
},
)
data = res.json() if res.content else None{
"advice": null,
"blockers": [],
"canonical": "harbourandfinch.example.org",
"dns_plan": {
"actions": [],
"can_apply": false,
"requires_confirmation": false,
"zone": null
},
"hosts": [
{
"cloudflare_zone": null,
"dns_answers": [
{
"type": "A",
"value": "198.51.100.21"
}
],
"dns_checked_at": "2026-11-02T15:25:00Z",
"dns_detail": "proxied_unconfirmed",
"dns_state": "unknown",
"dns_state_since": null,
"expected_ip": "203.0.113.10",
"host": "harbourandfinch.example.org",
"noindex": false,
"ok": false,
"problems": [
"Proxied by Cloudflare: the address behind it can't be checked from here. Make sure the Cloudflare record points at 203.0.113.10."
],
"redirects_to": null,
"role": "primary",
"tls": {
"checked_at": null,
"issuer": null,
"not_after": null,
"reason": null,
"state": "none"
}
}
],
"ok": false,
"platform_url": "https://example-org-examplecompany.harbourandfinch.example.net",
"primary_url": "https://harbourandfinch.example.org",
"proxied_unconfirmed": [
{
"challenge_path": {
"code": "reachable",
"note": "The certificate check gets through Cloudflare.",
"ok": true,
"status": 404
},
"confirmable": true,
"host": "harbourandfinch.example.org",
"verification": {
"found": true,
"name": "_cfcp-verify.example.org",
"state": "found",
"value": "cfcp-verify=3f1c0a9e5b7d2c4e8a6f1b0d9c7e5a3b"
}
}
],
"ran_at": "2026-11-02T15:25:00Z",
"role": "production",
"www": "bare"
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "managed_elsewhere",
"message": "This site is managed by another control panel",
"reason": "managed_elsewhere"
}{
"code": "invalid",
"errors": {
"enabled": [
"The enabled field is required."
]
},
"field": "enabled",
"message": "The enabled field is required.",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}