domains
POST /v1/domains/connect
Host DNS for a domain the customer already owns.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso domains.dns.manage; una clave que no lo tenga se rechazará con un código 403, no 404.
Donde va el ID de tu organización
Este endpoint toma org_id como un campo en el cuerpo JSON.
El id de tu organización se encuentra en la pantalla de claves de API en tu panel de control, junto a la propia clave. Es el mismo id en cada llamada que realices.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X POST https://api.zinndigital.com/v1/domains/connect \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
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.
Cuerpo de la solicitud
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
fqdn | string | Sí | The domain to host DNS for. Must be a zone apex, not a subdomain. |
org_id | Uuid | No | The organization to connect it in. Optional when the caller holds `domains.dns.manage` in exactly one org; required otherwise. |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
id | Uuid | Sí | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Sí | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
fqdn | Hostname | Sí | A fully-qualified DNS hostname, lowercase, no trailing dot. |
sld | string | Sí | — |
tld | string | Sí | — |
product_line | string | No | 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> | Sí | — |
status | DomainStatus | Sí | A domain's lifecycle state (docs/31 §4.10). |
registered_at | object | No | — |
expires_at | object | No | — |
auto_renew | boolean | Sí | — |
renew_years | integer | Sí | — |
registrar_lock | boolean | No | — |
privacy_enabled | boolean | No | — |
nameservers | string[] | Sí | — |
dnssec_enabled | boolean | No | — |
site_id | Uuid | null | No | The site this domain points at, if any. |
created_at | string | Sí | — |
updated_at | string | No | — |
delegation | Delegation | Sí | 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… |
Errores que este endpoint puede devolver
401 · 403 · 409 · 422 · 429 · 503