domains
GET /v1/domains/{domainId}/settings
Get a domain's registrar settings.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation sites.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/domains/{domainId}/settings \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
Auto-renew, registrar transfer lock, DNSSEC and WHOIS privacy for an owned domain. Served from our mirror of the registrar's state rather than a live vendor round-trip, so a detail screen never waits on a third party. Requires `sites.view`. **422 also covers a refusal that will never succeed.** A domain registered through the Cloudflare route has no API-writable transfer lock or WHOIS privacy — Cloudflare exposes neither for a registration made through its registrations endpoint — so the answer names the Cloudflare dashboard and offers support rather than `503 try again`, which is a sentence a customer would act on for ever.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
domainId (path) | Uuid | Oui | The domain's id. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
registrar | string | Oui | The registrar driver holding this domain (a driver name, never a vendor id). |
auto_renew | boolean | Oui | Whether we renew it before expiry. Ours, not the registrar's. |
transfer_lock | boolean | Oui | Registrar transfer lock (`clientTransferProhibited`) — blocks an outbound transfer. |
dnssec_enabled | boolean | Oui | — |
privacy_enabled | boolean | Oui | WHOIS privacy / registrant redaction, where the TLD supports it. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422 · 429