domains
POST /v1/domains/connect
Host DNS for a domain the customer already owns.
Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie domains.dns.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Waar je organisatie-id komt te staan
Dit eindpunt verwacht org_id als een veld in de JSON-body.
Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X POST https://api.zinndigital.com/v1/domains/connect \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de 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.
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
fqdn | string | Ja | The domain to host DNS for. Must be a zone apex, not a subdomain. |
org_id | Uuid | Nee | The organization to connect it in. Optional when the caller holds `domains.dns.manage` in exactly one org; required otherwise. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
fqdn | Hostname | Ja | A fully-qualified DNS hostname, lowercase, no trailing dot. |
sld | string | Ja | — |
tld | string | Ja | — |
product_line | string | Nee | 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> | Ja | — |
status | DomainStatus | Ja | A domain's lifecycle state (docs/31 §4.10). |
registered_at | object | Nee | — |
expires_at | object | Nee | — |
auto_renew | boolean | Ja | — |
renew_years | integer | Ja | — |
registrar_lock | boolean | Nee | — |
privacy_enabled | boolean | Nee | — |
nameservers | string[] | Ja | — |
dnssec_enabled | boolean | Nee | — |
site_id | Uuid | null | Nee | The site this domain points at, if any. |
created_at | string | Ja | — |
updated_at | string | Nee | — |
delegation | Delegation | Ja | 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… |
Fouten die dit eindpunt kan retourneren
401 · 403 · 409 · 422 · 429 · 503