Login | Register
live chat
24/7 Emergency Hotline USA
Home Plugins/Modules SSL Certificates Prices Contacts
Download documentation
InternetBS.net → Reseller/Registrar Domain Name API → Domain Private Whois Enable

Domain Private Whois Enable

Resource path /Domain/PrivateWhois/Enable)

https://testapi.internet.bs/Domain/PrivateWhois/Enable?ApiKey=testapi&Password=testpass&.......

The command is a purposely redundant auxiliary way to enable Private Whois for a specific domain. The command has been implemented only to allow simpler code writing/reading. You can obtain the exact same result invoking the command /Domain/Update and setting the parameter privateWhois to the value FULL or PARTIAL. Note the command will fail if you try to enable Private Whois for a domain not supporting this feature, for example for a .eu domain.
HTTPS POST/GET Request parameters:

Parameter name Description

ApiKey

The API key that we provided to you when you requested API access for your account

Password

The password we provided when you requested API access for your account

Domain

Domain name with extension.

type
(optional)

By default it is set to FULL, possible values are FULL and PARTIAL.

ResponseFormat
(optional)

This specifies how the response will be returned. Possible values are TEXT, JSON and XML.
The default value is TEXT however we encourage you to use JSON for easier result parsing (please refer to http://www.json.org for more details about JSON).

Returned data:

STATUS=SUCCESS or FAILURE or PENDING. Pending happens when there is a temporary problem (ex: when registry is not available). When the temporary problem passes your request will be processed.
TRANSACTID= Transaction ID reference
Domain=domain name

Example:

https://testapi.internet.bs/Domain/PrivateWhois/Enable?ApiKey=testapi&Password=testpass&Domain=test-api-domain1.net&type=PARTIAL

Result:

transactid=87c7dc1abb6264ce77e9a980123e4399
domain=test-api-domain1.net
status=SUCCESS
privatewhoisstatus=PARTIAL