domains

PUT /v1/domains/{domainId}/settings

Change a domain's registrar settings.

Tutti gli endpoint domains

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione domains.dns.manage; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

curl -X PUT https://api.zinndigital.com/v1/domains/{domainId}/settings \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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`.

Parametri

NomeTipoObbligatorioChe cos'è
domainId (path)UuidThe domain's id.

Corpo della richiesta

NomeTipoObbligatorioChe cos'è
auto_renewbooleanNo
transfer_lockbooleanNo
dnssec_enabledbooleanNo
privacy_enabledbooleanNo

Risposta

NomeTipoObbligatorioChe cos'è
registrarstringThe registrar driver holding this domain (a driver name, never a vendor id).
auto_renewbooleanWhether we renew it before expiry. Ours, not the registrar's.
transfer_lockbooleanRegistrar transfer lock (`clientTransferProhibited`) — blocks an outbound transfer.
dnssec_enabledboolean
privacy_enabledbooleanWHOIS privacy / registrant redaction, where the TLD supports it.

Errori che questo endpoint può restituire

401 · 403 · 404 · 422 · 429 · 503