domains
POST /v1/domains/connect
Host DNS for a domain the customer already owns.
Նույնականացում
Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա domains.dns.manage թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:
Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն
Այս վերջնակետը JSON մարմնում որպես դաշտ վերցնում է org_id-ը։
Ձեր կազմակերպության ID-ն գտնվում է Ձեր ղեկավարման վահանակի API բանալիների էկրանին՝ բուն բանալու կողքին: Այն նույն 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 վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ 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