domains
POST /v1/domains/connect
Host DNS for a domain the customer already owns.
प्रमाणन
बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास domains.dns.manage अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।
जहां आपकी संगठन आईडी आती है
यह एंडपॉइंट JSON बॉडी में एक फ़ील्ड के रूप में org_id लेता है।
आपकी ऑर्गनाइजेशन आईडी आपके डैशबोर्ड पर एपीआई कीज़ स्क्रीन पर, की के ठीक बगल में मौजूद है। यह आपके द्वारा की जाने वाली हर कॉल में समान आईडी होती है।
इसे आज़माएँ
कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।
curl -X POST https://api.zinndigital.com/v1/domains/connect \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें
विवरण
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.
अनुरोध बॉडी
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
fqdn | string | हाँ | The domain to host DNS for. Must be a zone apex, not a subdomain. |
org_id | Uuid | नहीं | The organization to connect it in. Optional when the caller holds `domains.dns.manage` in exactly one org; required otherwise. |
प्रतिक्रिया
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
id | Uuid | हाँ | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | हाँ | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
fqdn | Hostname | हाँ | A fully-qualified DNS hostname, lowercase, no trailing dot. |
sld | string | हाँ | — |
tld | string | हाँ | — |
product_line | string | नहीं | 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> | हाँ | — |
status | DomainStatus | हाँ | A domain's lifecycle state (docs/31 §4.10). |
registered_at | object | नहीं | — |
expires_at | object | नहीं | — |
auto_renew | boolean | हाँ | — |
renew_years | integer | हाँ | — |
registrar_lock | boolean | नहीं | — |
privacy_enabled | boolean | नहीं | — |
nameservers | string[] | हाँ | — |
dnssec_enabled | boolean | नहीं | — |
site_id | Uuid | null | नहीं | The site this domain points at, if any. |
created_at | string | हाँ | — |
updated_at | string | नहीं | — |
delegation | Delegation | हाँ | 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… |
त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है
401 · 403 · 409 · 422 · 429 · 503