domains
PUT /v1/domains/{domainId}/settings
Change a domain's registrar settings.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation domains.dns.manage ; 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 PUT https://api.zinndigital.com/v1/domains/{domainId}/settings \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'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
A **partial** update: an omitted field is left alone, never reset. Each changed flag is applied at the **registrar first** and mirrored onto our record only once it succeeds — so this endpoint never reports a protection (a transfer lock, WHOIS privacy) that the registrar has not actually applied. `auto_renew` is ours alone: we drive renewals, so it takes no registrar call. A registrar that refuses the change is a `503`. Requires `domains.dns.manage`.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
domainId (path) | Uuid | Oui | The domain's id. |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
auto_renew | boolean | Non | — |
transfer_lock | boolean | Non | — |
dnssec_enabled | boolean | Non | — |
privacy_enabled | boolean | Non | — |
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 · 503