domains
POST /v1/domains/connect
Host DNS for a domain the customer already owns.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění domains.dns.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Sem patří ID vaší organizace
Tento koncový bod přijímá org_id jako pole v těle JSON.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X POST https://api.zinndigital.com/v1/domains/connect \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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ělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
fqdn | string | Ano | The domain to host DNS for. Must be a zone apex, not a subdomain. |
org_id | Uuid | Ne | The organization to connect it in. Optional when the caller holds domains.dns.manage in exactly one org; required otherwise. |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
fqdn | Hostname | Ano | A fully-qualified DNS hostname, lowercase, no trailing dot. |
sld | string | Ano | — |
tld | string | Ano | — |
product_line | string | Ne | 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> | Ano | — |
status | DomainStatus | Ano | A domain's lifecycle state (docs/31 §4.10). |
registered_at | object | Ne | — |
expires_at | object | Ne | — |
auto_renew | boolean | Ano | — |
renew_years | integer | Ano | — |
registrar_lock | boolean | Ne | — |
privacy_enabled | boolean | Ne | — |
nameservers | string[] | Ano | — |
dnssec_enabled | boolean | Ne | — |
site_id | Uuid | null | Ne | The site this domain points at, if any. |
created_at | string | Ano | — |
updated_at | string | Ne | — |
delegation | Delegation | Ano | 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… |
Chyby, které může tento koncový bod vrátit
401 · 403 · 409 · 422 · 429 · 503