domains

GET /v1/domains/{domainId}/settings

Get a domain's registrar settings.

Alle domains-eindpunten

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie sites.view beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

curl -X GET https://api.zinndigital.com/v1/domains/{domainId}/settings \
  -H "Authorization: Bearer zdk_live_…"

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

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.

Parameters

NaamTypeVerplichtWat dit is
domainId (path)UuidJaThe domain's id.

Reactie

NaamTypeVerplichtWat dit is
registrarstringJaThe registrar driver holding this domain (a driver name, never a vendor id).
auto_renewbooleanJaWhether we renew it before expiry. Ours, not the registrar's.
transfer_lockbooleanJaRegistrar transfer lock (`clientTransferProhibited`) — blocks an outbound transfer.
dnssec_enabledbooleanJa
privacy_enabledbooleanJaWHOIS privacy / registrant redaction, where the TLD supports it.

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 422 · 429