domains
POST /v1/domains/connect
Host DNS for a domain the customer already owns.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението 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, за да можете да видите действителния отговор. Отворете този крайpoint в 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… |
Грешки, които този крайpoint може да върне
401 · 403 · 409 · 422 · 429 · 503