domains

PUT /v1/domains/{domainId}/settings

Change a domain's registrar settings.

Todos os endpoints de domains

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão domains.dns.manage; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Parâmetros

NomeTipoObrigatórioO que é
domainId (path)UuidSimThe domain's id.

Corpo da requisição

NomeTipoObrigatórioO que é
auto_renewbooleanNão
transfer_lockbooleanNão
dnssec_enabledbooleanNão
privacy_enabledbooleanNão

Resposta

NomeTipoObrigatórioO que é
registrarstringSimThe registrar driver holding this domain (a driver name, never a vendor id).
auto_renewbooleanSimWhether we renew it before expiry. Ours, not the registrar's.
transfer_lockbooleanSimRegistrar transfer lock (`clientTransferProhibited`) — blocks an outbound transfer.
dnssec_enabledbooleanSim
privacy_enabledbooleanSimWHOIS privacy / registrant redaction, where the TLD supports it.

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429 · 503