---
title: "Check a domain before attaching it"
url: https://docs.corefinity.com/api/reference/domains/check-site-attach-domain
type: endpoint
last_updated: 2026-11-13
feature: domains
related:
  - https://docs.corefinity.com/guides/sites/go-live/add-a-domain.md
  - https://docs.corefinity.com/mcp/tools/corestack_site_attach_domain_check.md
---
# 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.

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

- Scope: `read`
- Two-factor: required on your account (all)
- Rate limit: 20 a minute
- Try it in the console: on

## Path parameters

- `site` (integer, required): The id of a site row. A website's production site and each of its environments has its own id. Digits only.

## Body

- `canonical` (string, required): The hostname the site answers on. One of `hosts`.
- `default_store` (object or any or null): The Magento store shown on the primary; omitted or null uses Magento's default.
- `hosts` (array of strings, required): 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.
- `serve` (object): For each extra domain on Shopware or Magento 2, redirect or storefront. Each Magento storefront needs an entry in stores. Each name to one of `redirect`, `storefront`.
- `stores` (object): 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.
- `www` (string): Must match `canonical`. Left out, it follows `canonical`. One of `www`, `bare`.

## Request

### curl

```bash
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"
  }'
```

### PHP

```php
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();
```

### Node

```javascript
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);
```

### Python

```python
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
```

## Responses

### 200 The check.

```json
{
  "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"
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope (`scope_required`, with the `scope` to use), your company requires two-factor authentication and you have not set it up, or your account has no company that can use Managed Clusters, for example because the company was closed (`company_unavailable` or `company_not_enabled`, whichever the route checks first). For Managed Clusters routes; any other route uses `ForbiddenScopeOrTwoFactor`.

```json
{
  "code": "company_unavailable",
  "message": "Your company is unavailable.",
  "reason": "company_unavailable"
}
```

### 404 The id does not exist or is something you cannot see, or the feature is not on for your company (`feature_off`).

```json
{
  "code": "feature_off",
  "message": "Not found.",
  "reason": "feature_off"
}
```

### 409 The site is managed by another control panel, so it cannot be changed here.

```json
{
  "code": "managed_elsewhere",
  "message": "This site is managed by another control panel",
  "reason": "managed_elsewhere"
}
```

### 422 A field is missing or wrong. `field` names the first one and `errors` lists every one.

```json
{
  "code": "invalid",
  "errors": {
    "enabled": [
      "The enabled field is required."
    ]
  },
  "field": "enabled",
  "message": "The enabled field is required.",
  "reason": "invalid"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | 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`. |

## The same task elsewhere

- Guide: [Add a domain](https://docs.corefinity.com/guides/sites/go-live/add-a-domain.md)
- MCP tool: [`corestack_site_attach_domain_check`](https://docs.corefinity.com/mcp/tools/corestack_site_attach_domain_check.md)
