API-Dokumentation

WHOIS-Datenschutz

Aktiviert oder deaktiviert den WHOIS-Datenschutz für eine Domain. Wenn aktiviert, werden deine persönlichen Kontaktdaten in öffentlichen WHOIS-Abfragen verborgen.

Anfrage

PUT /api/v1/domains/{id}/whois-privacy

Erforderlicher Scope: domains:manage

Pfadparameter

Parameter Typ Beschreibung
id string Die Domain-ID

Header

Header Erforderlich Wert
Authorization Ja Bearer DEIN_API_SCHLÜSSEL
Content-Type Ja application/json

Anfragekörper

Feld Typ Erforderlich Beschreibung
enabled boolean Ja Ob der WHOIS-Datenschutz aktiviert (true) oder deaktiviert (false) werden soll

Antwort

{
  "data": {
    "enabled": true,
    "success": true
  }
}

Antwortfelder

Feld Typ Beschreibung
data.enabled boolean Der aktuelle WHOIS-Datenschutz-Status
data.success boolean Ob die Operation erfolgreich war

Fehler

Status Code Beschreibung
400 INVALID_ENABLED Der angegebene Wert ist kein gültiger Boolean
404 NOT_FOUND Die Domain wurde nicht gefunden
502 PROVIDER_ERROR Der Domain-Provider hat einen Fehler zurückgegeben

Beispiel

curl -X PUT https://site.quest/api/v1/domains/a1b2c3d4e5f6a1b2c3d4e5f6/whois-privacy \
  -H "Authorization: Bearer DEIN_API_SCHLÜSSEL" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true
  }'

MCP

Diese Aktion ist auch über das set_whois_privacy MCP-Tool verfügbar.