domains
POST /v1/domains/connect
Host DNS for a domain the customer already owns.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение domains.dns.manage; ключ без него отклоняется с кодом 403, а не 404.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве поля в теле JSON.
Идентификатор вашей организации находится на экране ключей 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.
Тело запроса
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
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