domains
POST /v1/domains/connect
Host DNS for a domain the customer already owns.
Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Khóa này phải có quyền domains.dns.manage; khóa không có quyền này sẽ bị từ chối với mã lỗi 403, không phải 404.
Nơi điền id tổ chức của bạn
Endpoint này nhận org_id làm một trường trong phần thân JSON.
Mã tổ chức của bạn nằm ở màn hình khóa API trong bảng điều khiển, ngay bên cạnh khóa đó. Đây là cùng một mã trong mọi lệnh gọi mà bạn thực hiện.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
curl -X POST https://api.zinndigital.com/v1/domains/connect \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
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.
Nội dung yêu cầu
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
fqdn | string | Có | The domain to host DNS for. Must be a zone apex, not a subdomain. |
org_id | Uuid | Không | The organization to connect it in. Optional when the caller holds `domains.dns.manage` in exactly one org; required otherwise. |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
id | Uuid | Có | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Có | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
fqdn | Hostname | Có | A fully-qualified DNS hostname, lowercase, no trailing dot. |
sld | string | Có | — |
tld | string | Có | — |
product_line | string | Không | 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> | Có | — |
status | DomainStatus | Có | A domain's lifecycle state (docs/31 §4.10). |
registered_at | object | Không | — |
expires_at | object | Không | — |
auto_renew | boolean | Có | — |
renew_years | integer | Có | — |
registrar_lock | boolean | Không | — |
privacy_enabled | boolean | Không | — |
nameservers | string[] | Có | — |
dnssec_enabled | boolean | Không | — |
site_id | Uuid | null | Không | The site this domain points at, if any. |
created_at | string | Có | — |
updated_at | string | Không | — |
delegation | Delegation | Có | 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… |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 409 · 422 · 429 · 503