Netim Direct
Updated on 8 January 2024

Set whois privacy

1 Description
2 Common language examples

Description

PATCH https://rest.netim.com/3.0/domain/{domain}/preference/

Enable or disable the whois privacy feature.

Common language examples

<?php
 
	$ch = curl_init();
 
	$body = array(
		"codePref" => "whois_privacy",
		"value" => "1",
	);
 
	curl_setopt($ch, CURLOPT_URL,"https://rest.netim.com/3.0/domain/$domain/preference/");
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
	curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
	curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer $sessionID", "Content-type: application/json"]);
	curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
	curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body));
 
	$result = json_decode(curl_exec ($ch), true);
	$status_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
	curl_close ($ch);
 
import java.util.Base64;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
 
public class Example {
 
	public static void main(String args[]) throws Exception {
		String sessionID = "12345678";
		String domain = "example.com";
 
		String body = "{\"codePref\":\"whois_privacy\",\"value\":\"1\",}";
 
		HttpClient client = HttpClient.newHttpClient();
		HttpRequest request = HttpRequest.newBuilder()
			.uri(URI.create("https://rest.netim.com/3.0/domain/" + domain + "/preference/"))
			.method("PATCH", HttpRequest.BodyPublishers.ofString(body))
			.header("Content-Type", "application/json")
			.header("Accept-Language", "EN")
			.header("Authorization", "Bearer " + sessionID)
			.build();
		HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
 
		String result = response.body().toString();
	}
}
#!/usr/bin/python3
 
import json
import requests
 
domain = 'example.com'
 
url = 'https://rest.netim.com/3.0/domain/' + domain + '/preference/'
 
sessionId = "1234567"
 
data = {
    "codePref":"whois_privacy",
    "value":"1",
}
 
headers = {"Authorization": "Bearer " + sessionId, "Content-Type": "application/json"}
 
 
response = requests.patch(url, headers=headers, data=json.dumps(data))
curl -X PATCH https://rest.netim.com/3.0/domain/example.com/preference/ \
-H 'Authorization: Bearer b0f13a3c01d9cce2a9a44cd729f81c26=' \
-H 'Content-type: application/json' \
-d '{"codePref":"whois_privacy","value":"1",}'

URL Parameters

  • {domain}
    Domain name.

Headers

  • Authorization string

    The Autorization header must start with “Bearer ” followed by the session ID.
    Example:”Autorization: Bearer b0f13a3c01d9cce2a9a44cd729f81c26″

  • Content-type string

    Content type of the request

    Only “application/json” is accepted

Body

REQUIRED

  • codePref string
    Set to: whois_privacy.
  • value string
    • Set to: “0” to disable, “1” to enable.

JSON example

{
    "codePref":"whois_privacy", 
    "value":"1", 
}

This setting is available according to the extension.

See structdomaintldinfo.HasWhoisPrivacy