domains
POST /v1/domains/connect
Host DNS for a domain the customer already owns.
Authentication
Send an API key as a bearer token. The key must carry the domains.dns.manage permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a field in the JSON body.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/domains/connect \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Creates the domain's zone at our DNS provider, branded with our vanity nameservers in the same operation, and returns the delegation to set at the customer's **own** registrar. This is the BYO path — we become the authoritative DNS, **not** the registrar — so it needs no registrar credential and is how "premium DNS included on every plan" is delivered. The domain must be a zone apex (a subdomain is a `422`) and must not already exist on the platform (a `409` — worded so it never confirms another tenant holds it). Requires `domains.dns.manage`, the same authority that governs the records this makes editable. ⛔ There is deliberately **no `product_line` field**: it is derived server-side from the org's subscriptions, because it decides whether shared fleet A/AAAA records are hidden from this customer. Accepting it would let a Footprint-Free customer connect a domain as `mainstream` and read the fleet IPs.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
fqdn | string | Yes | The domain to host DNS for. Must be a zone apex, not a subdomain. |
org_id | Uuid | No | The organization to connect it in. Optional when the caller holds `domains.dns.manage` in exactly one org; required otherwise. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
fqdn | Hostname | Yes | A fully-qualified DNS hostname, lowercase, no trailing dot. |
sld | string | Yes | — |
tld | string | Yes | — |
product_line | string | No | The product line this domain was created on. **Not decoration** — it is what decides whether the shared fleet A/AAAA records are hidden from the customer (register #93), so the… |
ownership_mode | string<registered, connected, transferring_in> | Yes | — |
status | DomainStatus | Yes | A domain's lifecycle state (docs/31 §4.10). |
registered_at | object | No | — |
expires_at | object | No | — |
auto_renew | boolean | Yes | — |
renew_years | integer | Yes | — |
registrar_lock | boolean | No | — |
privacy_enabled | boolean | No | — |
nameservers | string[] | Yes | — |
dnssec_enabled | boolean | No | — |
site_id | Uuid | null | No | The site this domain points at, if any. |
created_at | string | Yes | — |
updated_at | string | No | — |
delegation | Delegation | Yes | Where a domain's DNS delegation actually points. Several observations, not one boolean, because they answer different questions and collapsing them hides the only one that means… |
Errors this endpoint can return
401 · 403 · 409 · 422 · 429 · 503