domains

POST /v1/domains/connect

Host DNS for a domain the customer already owns.

Bütün domains nöqtələri

Doğrulama

API açarını bearer token kimi göndərin. Açar domains.dns.manage icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.

Təşkilatınızın identifikatorunun yerləşdiyi yer

Bu son nöqtə JSON gövdəsində sahə kimi org_id qəbul edir.

Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.

Sınaqdan keçir

Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.

curl -X POST https://api.zinndigital.com/v1/domains/connect \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "fqdn": <string> }'

Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın

Təfərrüatlar

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.

Sorğu gövdəsi

AdTipTələb olunurNədir
fqdnstringBəliThe domain to host DNS for. Must be a zone apex, not a subdomain.
org_idUuidXeyrThe organization to connect it in. Optional when the caller holds `domains.dns.manage` in exactly one org; required otherwise.

Cavab

AdTipTələb olunurNədir
idUuidBəliUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidBəliUUIDv7 identifier — sortable by creation time (docs/02 §8).
fqdnHostnameBəliA fully-qualified DNS hostname, lowercase, no trailing dot.
sldstringBəli
tldstringBəli
product_linestringXeyrThe 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_modestring<registered, connected, transferring_in>Bəli
statusDomainStatusBəliA domain's lifecycle state (docs/31 §4.10).
registered_atobjectXeyr
expires_atobjectXeyr
auto_renewbooleanBəli
renew_yearsintegerBəli
registrar_lockbooleanXeyr
privacy_enabledbooleanXeyr
nameserversstring[]Bəli
dnssec_enabledbooleanXeyr
site_idUuid | nullXeyrThe site this domain points at, if any.
created_atstringBəli
updated_atstringXeyr
delegationDelegationBəliWhere 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…

Bu son nöqtənin qaytara biləcəyi xətalar

401 · 403 · 409 · 422 · 429 · 503