domains
POST /v1/domains/connect
Host DNS for a domain the customer already owns.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung domains.dns.manage verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.
Hier kommt Ihre Organisations-ID hin
Dieser Endpunkt akzeptiert org_id als Feld im JSON-Body.
Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X POST https://api.zinndigital.com/v1/domains/connect \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
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.
Anfragekörper
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
fqdn | string | Ja | The domain to host DNS for. Must be a zone apex, not a subdomain. |
org_id | Uuid | Nein | The organization to connect it in. Optional when the caller holds `domains.dns.manage` in exactly one org; required otherwise. |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
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 | Nein | 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 | Nein | — |
expires_at | object | Nein | — |
auto_renew | boolean | Ja | — |
renew_years | integer | Ja | — |
registrar_lock | boolean | Nein | — |
privacy_enabled | boolean | Nein | — |
nameservers | string[] | Ja | — |
dnssec_enabled | boolean | Nein | — |
site_id | Uuid | null | Nein | The site this domain points at, if any. |
created_at | string | Ja | — |
updated_at | string | Nein | — |
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… |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 409 · 422 · 429 · 503