API Documentation

WHOIS Privacy

Enable or disable WHOIS privacy protection for a domain. When enabled, your personal contact information is hidden from public WHOIS lookups.

Request

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

Required scope: domains:manage

Path Parameters

Parameter Type Description
id string The domain ID

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY
Content-Type Yes application/json

Request Body

Field Type Required Description
enabled boolean Yes Whether to enable (true) or disable (false) WHOIS privacy

Response

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

Response Fields

Field Type Description
data.enabled boolean The current WHOIS privacy state
data.success boolean Whether the operation was successful

Errors

Status Code Description
400 INVALID_ENABLED The provided value is not a valid boolean
404 NOT_FOUND The domain was not found
502 PROVIDER_ERROR The domain provider returned an error

Example

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

MCP

This action is also available via the set_whois_privacy MCP tool.