domains
POST /v1/domains/connect
Host DNS for a domain the customer already owns.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão domains.dns.manage; uma chave sem ela é recusada com 403, e não 404.
Onde vai o ID da sua organização
Este endpoint aceita org_id como um campo no corpo JSON.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X POST https://api.zinndigital.com/v1/domains/connect \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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.
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
fqdn | string | Sim | The domain to host DNS for. Must be a zone apex, not a subdomain. |
org_id | Uuid | Não | The organization to connect it in. Optional when the caller holds `domains.dns.manage` in exactly one org; required otherwise. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
fqdn | Hostname | Sim | A fully-qualified DNS hostname, lowercase, no trailing dot. |
sld | string | Sim | — |
tld | string | Sim | — |
product_line | string | Não | 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> | Sim | — |
status | DomainStatus | Sim | A domain's lifecycle state (docs/31 §4.10). |
registered_at | object | Não | — |
expires_at | object | Não | — |
auto_renew | boolean | Sim | — |
renew_years | integer | Sim | — |
registrar_lock | boolean | Não | — |
privacy_enabled | boolean | Não | — |
nameservers | string[] | Sim | — |
dnssec_enabled | boolean | Não | — |
site_id | Uuid | null | Não | The site this domain points at, if any. |
created_at | string | Sim | — |
updated_at | string | Não | — |
delegation | Delegation | Sim | 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… |
Erros que este endpoint pode retornar
401 · 403 · 409 · 422 · 429 · 503