CorefinityCorefinityDocs
Open the Control PanelControl Panel
Domains · 2 of 8

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.

POST/api/corestack/sites/{site}/attach-domain/check

Path parameters

siteintegerRequired

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

canonicalstringRequired

The hostname the site answers on. One of hosts.

default_storeobject or any or null

The Magento store shown on the primary; omitted or null uses Magento's default.

hostsarray of stringsRequired

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.

serveobject

For each extra domain on Shopware or Magento 2, redirect or storefront. Each Magento storefront needs an entry in stores.

each name →redirectstorefront
storesobject

Magento 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.

wwwstring

Must match canonical. Left out, it follows canonical.

wwwbare

Returns

200 The check.

Fields of the 200 answer
adviceobject or any or nullRequired
blockersarray of objectsRequired

What refuses the attach whatever DNS says, with the reason and message the attach would answer.

Fields of each item
messagestringRequired
reasonstringRequired
canonicalstringRequired
dns_planobject or any or nullRequired
hostsarray of objectsRequired
Fields of each item
cloudflare_zoneobject or nullRequired

The connected Cloudflare zone the hostname is in, with its id and name. proxied and record_id are sent as null.

dns_answersarray of objects or nullRequired
Fields of each item
typestring
valuestring
dns_checked_atstring or nullRequired

Format: date-time.

dns_detailstring or nullRequired
dns_statestringRequired
points_hereproxied_hereelsewhereunresolvedunknown
dns_state_sincestring or nullRequired
expected_ipstring or nullRequired

The address the hostname must point at.

hoststringRequired
noindexboolean

True when search engines are asked not to index this hostname. Not sent in the answer of POST …/domains/point-dns.

redirects_tostring or nullRequired

The hostname this one redirects to. Null when it serves the site itself.

rolestringRequired
primaryaliaspreviewlegacystore
servestring

Sent for extra domains on Shopware, and on Magento 2 while Magento store domains are available.

redirectstorefront
storeobject

A Magento storefront alias's store choice, or the selected choice on the primary. An unmapped alias shows the default store.

Fields
codestring or nullRequired
namestring or nullRequired
previousobject or any or null

While pending, the store losing this host; null for a new storefront. Omitted otherwise.

statestringRequired
mappedpendingunmapped
typestring or nullRequired
websitestorenull
tlsobject or nullRequired

The certificate for the hostname.

Fields
checked_atstring or null

Format: date-time.

issuerstring or null
not_afterstring or null
reasonstring or null
statestring
readypendingfailednone
okbooleanRequired

True when the hostname is ready.

problemsarray of stringsRequired

What to fix, in plain words. Empty when ok is true.

okbooleanRequired

True when every hostname is ready.

platform_urlstring or nullRequired

The environment's own address on the platform.

primary_urlstringRequired

The address the attach would produce.

proxied_unconfirmedarray of objectsRequired

Each hostname behind Cloudflare that the check cannot look behind. Empty when there is none.

Fields of each item
challenge_pathobjectRequired

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
codestring
notestring or null
okboolean or null
statusinteger or null
confirmablebooleanRequired

True when the certificate check gets through and the TXT record is found.

hoststringRequired
verificationobjectRequired

The TXT record that proves the hostname is yours.

Fields
foundboolean
namestring
statestring
valuestring or null
ran_atstringRequired

Format: date-time.

rolestringRequired

The environment's role, such as production or staging.

wwwstringRequired
wwwbare

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
404feature_offThis feature is not on for your organisation yet.
409managed_elsewhereThis site is read-only here. Change it in the control panel that manages it.
422invalidFix the field named in field; errors says why.
429rate_limitedWait 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"
  }'
{
  "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"
}
Try it
Held in this tab's memory only. Never stored or sent to us.

This sends a real POST request and changes your account.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT