domains
POST /v1/domains/connect
Host DNS for a domain the customer already owns.
Pengesahan
Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran domains.dns.manage; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.
Tempat ID organisasi anda diletakkan
Titik akhir ini mengambil org_id sebagai medan dalam kandungan JSON.
ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X POST https://api.zinndigital.com/v1/domains/connect \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
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.
Badan permintaan
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
fqdn | string | Ya | The domain to host DNS for. Must be a zone apex, not a subdomain. |
org_id | Uuid | Tidak | The organization to connect it in. Optional when the caller holds `domains.dns.manage` in exactly one org; required otherwise. |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
fqdn | Hostname | Ya | A fully-qualified DNS hostname, lowercase, no trailing dot. |
sld | string | Ya | — |
tld | string | Ya | — |
product_line | string | Tidak | 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> | Ya | — |
status | DomainStatus | Ya | A domain's lifecycle state (docs/31 §4.10). |
registered_at | object | Tidak | — |
expires_at | object | Tidak | — |
auto_renew | boolean | Ya | — |
renew_years | integer | Ya | — |
registrar_lock | boolean | Tidak | — |
privacy_enabled | boolean | Tidak | — |
nameservers | string[] | Ya | — |
dnssec_enabled | boolean | Tidak | — |
site_id | Uuid | null | Tidak | The site this domain points at, if any. |
created_at | string | Ya | — |
updated_at | string | Tidak | — |
delegation | Delegation | Ya | 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… |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 409 · 422 · 429 · 503