domains
POST /v1/domains/connect
Host DNS for a domain the customer already owns.
Kimlik Doğrulama
Bearer token olarak bir API anahtarı gönderin. Anahtar domains.dns.manage iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.
Kurum kimliğinizin yazılacağı yer
Bu uç nokta, JSON gövdesinde bir alan olarak org_id alır.
Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X POST https://api.zinndigital.com/v1/domains/connect \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
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.
İstek gövdesi
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
fqdn | string | Evet | The domain to host DNS for. Must be a zone apex, not a subdomain. |
org_id | Uuid | Hayır | The organization to connect it in. Optional when the caller holds `domains.dns.manage` in exactly one org; required otherwise. |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
id | Uuid | Evet | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Evet | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
fqdn | Hostname | Evet | A fully-qualified DNS hostname, lowercase, no trailing dot. |
sld | string | Evet | — |
tld | string | Evet | — |
product_line | string | Hayır | 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> | Evet | — |
status | DomainStatus | Evet | A domain's lifecycle state (docs/31 §4.10). |
registered_at | object | Hayır | — |
expires_at | object | Hayır | — |
auto_renew | boolean | Evet | — |
renew_years | integer | Evet | — |
registrar_lock | boolean | Hayır | — |
privacy_enabled | boolean | Hayır | — |
nameservers | string[] | Evet | — |
dnssec_enabled | boolean | Hayır | — |
site_id | Uuid | null | Hayır | The site this domain points at, if any. |
created_at | string | Evet | — |
updated_at | string | Hayır | — |
delegation | Delegation | Evet | 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… |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 409 · 422 · 429 · 503