domains
POST /v1/domains/connect
Host DNS for a domain the customer already owns.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) domains.dns.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
A szervezet azonosítójának helye
Ez a végpont a org_id mezőt várja a JSON törzsben.
A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X POST https://api.zinndigital.com/v1/domains/connect \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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.
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
fqdn | string | Igen | The domain to host DNS for. Must be a zone apex, not a subdomain. |
org_id | Uuid | Nem | The organization to connect it in. Optional when the caller holds `domains.dns.manage` in exactly one org; required otherwise. |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
fqdn | Hostname | Igen | A fully-qualified DNS hostname, lowercase, no trailing dot. |
sld | string | Igen | — |
tld | string | Igen | — |
product_line | string | Nem | 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> | Igen | — |
status | DomainStatus | Igen | A domain's lifecycle state (docs/31 §4.10). |
registered_at | object | Nem | — |
expires_at | object | Nem | — |
auto_renew | boolean | Igen | — |
renew_years | integer | Igen | — |
registrar_lock | boolean | Nem | — |
privacy_enabled | boolean | Nem | — |
nameservers | string[] | Igen | — |
dnssec_enabled | boolean | Nem | — |
site_id | Uuid | null | Nem | The site this domain points at, if any. |
created_at | string | Igen | — |
updated_at | string | Nem | — |
delegation | Delegation | Igen | 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… |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 409 · 422 · 429 · 503