Configure the Display of Contact Data in the Whois
To follow this guide, make sure you are connected to OVHcloud API. You may find more information on the API introduction page if needed.
Table of Contents
- Introduction
- Order a Domain Name
- Tasks Management
- Manage Contacts of a Domain Name
- Managing Eligibility Rules
- Configure the Display of Contact Data in the Whois
- Configure the DNS of your Domain Name
- Transfer a Domain Name
We remind you that the given API routes links lead to European API. Do not forget to replace https://eu.api.ovh.com with https://ca.api.ovh.com in API URLs to use it with your identifier.
Introduction
The Whois is a search service that provides information about a domain name. This information can have various uses but is often used to find and contact the holder of a domain name. This information is displayed as a non-standardized text, which was displayed in plain text until recently.
RDAP was designed as a successor to Whois and has several advantages over it, including:
- Support for internationalization
- Standardization of the data format
- The ability to provide distinguished access to the data
This section is dedicated to API routes used to set up the disclosure and obfuscation of the various contact data of a domain name in the Whois and the RDAP.
Information disclosure (optin)
Since the implementation of the RGPD, the Whois data concerning admin, tech, billing and owner contacts are hidden by default
if they are natural persons.
However, it is possible to disclose all of the data according the optin rules applied to the domain name.
Retrieving optin rules
The following API allows you to retrieve the disclosure rules applicable to a domain name.
| Parameter | Required | Description |
|---|---|---|
serviceName | true | The domain name involved |
The following response shows the three different types of rules that can be found:
- The
admincontact is omitted in the response, which means that it is not possible to configure the disclosure of its data. - The
techcontact with an emptyfieldtable means that it is possible to disclose its information. However, the choice of the disclosed information is not customizable (it is all or nothing). - Regarding the
ownercontact, the presence of fields in thefieldnode means that the information is hidden. However, the choice of information disclosed cannot be customised: either all information is displayed, or none is displayed.
Retrieving the optin configuration of a domain name
The following API is used to retrieve the disclosure configuration applied to a domain name.
| Parameter | Required | Description |
|---|---|---|
serviceName | true | The domain name involved |
The above response can be read as follows:
- The
adminandbillingcontacts are not included in the response, which means that no information about them will be displayed in the Whois. - The
techcontact with an empty array in thefieldsfield means that the contact's information must be disclosed and will be displayed in the Whois. - Regarding the
ownercontact, we can see that the fields are configured to be disclosed and will be displayed in the Whois.
Updating the optin configuration
The following API allows you to update the disclosure configuration applied to a domain name.
| Parameter | Required | Default | Description |
|---|---|---|---|
serviceName | true | The domain name involved | |
optin (body) | true | [] | Disclosure configuration |
Email obfuscation
Beyond the disclosure of data on the Whois, OVHcloud gives the possibility to obfuscate the email addresses of the contacts in the Whois.
Since the implementation of the RGPD, this feature is activated by default for all domain names. However, it is possible to disable this obfuscation depending on the domain name.
Retrieving email obfuscation rules
The following API allows to know the email obfuscation rules that apply on a domain name.
| Parameter | Required | Description |
|---|---|---|
serviceName | true | The domain name involved |
The answer above indicates that email addresses can be obfuscated on the admin, tech, billing and owner contacts.
Retrieving the email obfuscation configuration for a domain name
The following API allows to retrieve the obfuscation configuration applied on a domain name.
| Parameter | Required | Description |
|---|---|---|
serviceName | true | The domain name involved |
The above response can be read as follows:
- The
billingcontact is not present in the response, which means that no email obfuscation is applied to this contact. - The
techandownercontacts have astatusatdoneand a non-zerovalue, this indicates that both of these contacts have their email obfuscated using this value and the email redirection is active. - About the
admincontact, we can see that thevalueexists but that thestatusis attodo, which means that the contact is configured to be obfuscated but the email address redirection is not yet active.
Updating the configuration of email obfuscation
The following API allows to update the email obfuscation configuration applied on a domain name.
| Parameter | Required | Default | Description |
|---|---|---|---|
serviceName | true | The domain name involved | |
contacts (body) | true | [] | List of contact types on which obfuscation must be applied |
Regeneration of obfuscated emails
The following API allows you to regenerate obfuscated emails of a domain name.
| Parameter | Required | Default | Description |
|---|---|---|---|
serviceName | true | The domain name involved | |
contacts (body) | true | [] | List of contact types on which obfuscation must be regenerated |
Status 200