domains
POST /v1/domains/connect
Host DNS for a domain the customer already owns.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה domains.dns.manage; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את org_id כשדה בגוף ה-JSON.
מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
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