domains
POST /v1/domains/connect
Host DNS for a domain the customer already owns.
Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Кілтте domains.dns.manage рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.
Ұйымыңыздың идентификаторы орналасатын жер
Бұл соңғы нүкте JSON корпусында өріс ретінде org_id қабылдайды.
Сіздің ұйым идентификаторыңыз басқару панеліндегі 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.
Сұрау денесі
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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. |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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