domains

GET /v1/domains/{domainId}/settings

Get 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 sites.view; 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 GET https://api.zinndigital.com/v1/domains/{domainId}/settings \
  -H "Authorization: Bearer zdk_live_…"

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

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.

Parametri

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

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