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