API Home
Guides & Flows
Core API Overview
name.com Core API Reference
- GETList Domains
- POSTCreate Domain
- GETGet Domain
- PATCHUpdate a domain
- GETGet Auth Code For Domain
- GETGet Pricing For Domain
- POSTPurchase Privacy
- POSTRenew Domain
- POSTSet Contacts
- POSTSet Nameservers
- POSTCheck Availability
- POSTSearch
- POSTZone Check
- POSTDisable Autorenewdeprecated
- POSTDisable Whois Privacydeprecated
- POSTEnable Autorenewdeprecated
- POSTEnable Whois Privacydeprecated
- POSTLock Domaindeprecated
- POSTUnlock Domaindeprecated
- GET
Resources
curl --request POST \
--url https://api.dev.name.com/core/v1/domains/{domainName}:purchasePrivacy \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"purchasePrice": 123,
"years": 1
}
'{
"order": 123,
"totalPaid": 4.99,
"domain": {
"domainName": "example.com",
"createDate": "2023-01-15T14:30:00Z",
"expireDate": "2025-01-15T14:30:00Z",
"autorenewEnabled": true,
"locked": true,
"privacyEnabled": true,
"contacts": {
"admin": {
"firstName": "John",
"lastName": "Doe",
"companyName": "Example Inc.",
"address1": "123 Main Street",
"address2": "Suite 400",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"fax": "+15557654321",
"isVerified": true
},
"billing": {
"firstName": "John",
"lastName": "Doe",
"companyName": "Example Inc.",
"address1": "123 Main Street",
"address2": "Suite 400",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"fax": "+15557654321",
"isVerified": true
},
"registrant": {
"firstName": "John",
"lastName": "Doe",
"companyName": "Example Inc.",
"address1": "123 Main Street",
"address2": "Suite 400",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"fax": "+15557654321",
"isVerified": true
},
"tech": {
"firstName": "John",
"lastName": "Doe",
"companyName": "Example Inc.",
"address1": "123 Main Street",
"address2": "Suite 400",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"fax": "+15557654321",
"isVerified": true
}
},
"nameservers": [
"ns1.example.com",
"ns2.example.com"
],
"renewalPrice": 12.99
}
}Purchase Privacy
Adds or renews WHOIS privacy protection for a domain. This is used to ensure personal contact details remain hidden from public WHOIS lookups. If WHOIS privacy is already enabled, this will extend the protection. If it’s not yet active, this will both purchase and enable the service. This is a billable action unless covered by a bundled privacy plan.
curl --request POST \
--url https://api.dev.name.com/core/v1/domains/{domainName}:purchasePrivacy \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"purchasePrice": 123,
"years": 1
}
'{
"order": 123,
"totalPaid": 4.99,
"domain": {
"domainName": "example.com",
"createDate": "2023-01-15T14:30:00Z",
"expireDate": "2025-01-15T14:30:00Z",
"autorenewEnabled": true,
"locked": true,
"privacyEnabled": true,
"contacts": {
"admin": {
"firstName": "John",
"lastName": "Doe",
"companyName": "Example Inc.",
"address1": "123 Main Street",
"address2": "Suite 400",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"fax": "+15557654321",
"isVerified": true
},
"billing": {
"firstName": "John",
"lastName": "Doe",
"companyName": "Example Inc.",
"address1": "123 Main Street",
"address2": "Suite 400",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"fax": "+15557654321",
"isVerified": true
},
"registrant": {
"firstName": "John",
"lastName": "Doe",
"companyName": "Example Inc.",
"address1": "123 Main Street",
"address2": "Suite 400",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"fax": "+15557654321",
"isVerified": true
},
"tech": {
"firstName": "John",
"lastName": "Doe",
"companyName": "Example Inc.",
"address1": "123 Main Street",
"address2": "Suite 400",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"email": "[email protected]",
"phone": "+15551234567",
"fax": "+15557654321",
"isVerified": true
}
},
"nameservers": [
"ns1.example.com",
"ns2.example.com"
],
"renewalPrice": 12.99
}
}Authorizations
Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic <base64(username:token)>' header; 'curl -u username:token' is equivalent. For sandbox, append "-test" to your username and use your sandbox token on api.dev.name.com.
Headers
A unique string (e.g., a UUID v4) to make the request idempotent. This key ensures that if the request is retried, the operation will not be performed multiple times. Subsequent requests with the same key will return the original result.
"083910ef-04e4-4bd1-a0bf-3737fe005ca8"
Path Parameters
DomainName is the domain to purchase Whois Privacy for.
Body
PrivacyRequest passes the domain name as well as the purchase parameters to the PurchasePrivacy function.
Response
A successful response.
PrivacyResponse contains the updated domain info as well as the order info for the newly purchased Whois Privacy.
Order is an identifier for this purchase.
TotalPaid is the total amount paid, including VAT.
4.99
The response format for a domain.
Show child attributes
Show child attributes
The punycode-encoded value of the domain name. The punycode-encoded value of the domain name.
"example.com"
The date and time when the domain was created at the registry. The date and time when the domain was created at the registry.
"2023-01-15T14:30:00Z"
The date and time when the domain will expire. The date and time when the domain will expire.
"2025-01-15T14:30:00Z"
Indicates whether the domain is set to renew automatically before expiration. Indicates whether the domain is set to renew automatically before expiration.
true
Indicates if the domain is locked, preventing transfers to another registrar. Indicates if the domain is locked, preventing transfers to another registrar.
true
Indicates if Whois Privacy is enabled for this domain. Indicates if Whois Privacy is enabled for this domain.
true
Contacts stores the contact information for the roles related to domains. Contacts stores the contact information for the roles related to domains.
Show child attributes
Show child attributes
Contact contains all relevant contact data for a domain registrant. This schema is used for API responses and may contain null values for legacy data. For creating or updating contacts, use ContactRequest which enforces all validation requirements. Contact contains all relevant contact data for a domain registrant. This schema is used for API responses and may contain null values for legacy data. For creating or updating contacts, use ContactRequest which enforces all validation requirements.
Show child attributes
Show child attributes
First name of the contact. First name of the contact.
"John"
Last name of the contact. Last name of the contact.
"Doe"
Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise. Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise.
"Example Inc."
The first line of the contact's address. The first line of the contact's address.
"123 Main Street"
The second line of the contact's address (optional). The second line of the contact's address (optional).
"Suite 400"
City of the contact's address. City of the contact's address.
"New York"
State or Province of the contact's address. State or Province of the contact's address.
"NY"
ZIP or Postal Code of the contact's address. ZIP or Postal Code of the contact's address.
"10001"
Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code. Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.
"US"
Phone number of the contact. Should follow the E.164 international format: "+[country code][number]". Phone number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15551234567"
Fax number of the contact. Should follow the E.164 international format: "+[country code][number]". Fax number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15557654321"
Indicates if the contact has been verified as per ICANN requirements. If the value is false it indicates that the contact has not completed the required verification process. This property is read-only and will be included in responses but should not be included in requests.
Indicates if the contact has been verified as per ICANN requirements. If the value is false it indicates that the contact has not completed the required verification process. This property is read-only and will be included in responses but should not be included in requests.
true
Contact contains all relevant contact data for a domain registrant. This schema is used for API responses and may contain null values for legacy data. For creating or updating contacts, use ContactRequest which enforces all validation requirements. Contact contains all relevant contact data for a domain registrant. This schema is used for API responses and may contain null values for legacy data. For creating or updating contacts, use ContactRequest which enforces all validation requirements.
Show child attributes
Show child attributes
First name of the contact. First name of the contact.
"John"
Last name of the contact. Last name of the contact.
"Doe"
Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise. Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise.
"Example Inc."
The first line of the contact's address. The first line of the contact's address.
"123 Main Street"
The second line of the contact's address (optional). The second line of the contact's address (optional).
"Suite 400"
City of the contact's address. City of the contact's address.
"New York"
State or Province of the contact's address. State or Province of the contact's address.
"NY"
ZIP or Postal Code of the contact's address. ZIP or Postal Code of the contact's address.
"10001"
Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code. Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.
"US"
Phone number of the contact. Should follow the E.164 international format: "+[country code][number]". Phone number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15551234567"
Fax number of the contact. Should follow the E.164 international format: "+[country code][number]". Fax number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15557654321"
Indicates if the contact has been verified as per ICANN requirements. If the value is false it indicates that the contact has not completed the required verification process. This property is read-only and will be included in responses but should not be included in requests.
Indicates if the contact has been verified as per ICANN requirements. If the value is false it indicates that the contact has not completed the required verification process. This property is read-only and will be included in responses but should not be included in requests.
true
Contact contains all relevant contact data for a domain registrant. This schema is used for API responses and may contain null values for legacy data. For creating or updating contacts, use RegistrantContactRequest which enforces all validation requirements. Contact contains all relevant contact data for a domain registrant. This schema is used for API responses and may contain null values for legacy data. For creating or updating contacts, use RegistrantContactRequest which enforces all validation requirements.
Show child attributes
Show child attributes
First name of the contact. First name of the contact.
"John"
Last name of the contact. Last name of the contact.
"Doe"
Company name of the contact. Leave blank if the contact is an individual. Please be advised that ICANN policy links the "Company Name" field (Organization) in your domain's contact details to its legal ownership. If this field contains information, the listed organization is considered the legal "Registered Name Holder" (domain owner). Company name of the contact. Leave blank if the contact is an individual. Please be advised that ICANN policy links the "Company Name" field (Organization) in your domain's contact details to its legal ownership. If this field contains information, the listed organization is considered the legal "Registered Name Holder" (domain owner).
"Example Inc."
The first line of the contact's address. The first line of the contact's address.
"123 Main Street"
The second line of the contact's address (optional). The second line of the contact's address (optional).
"Suite 400"
City of the contact's address. City of the contact's address.
"New York"
State or Province of the contact's address. State or Province of the contact's address.
"NY"
ZIP or Postal Code of the contact's address. ZIP or Postal Code of the contact's address.
"10001"
Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code. Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.
"US"
Phone number of the contact. Should follow the E.164 international format: "+[country code][number]". Phone number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15551234567"
Fax number of the contact. Should follow the E.164 international format: "+[country code][number]". Fax number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15557654321"
Indicates if the contact has been verified as per ICANN requirements. If the value is false it indicates that the contact has not completed the required verification process. This property is read-only and will be included in responses but should not be included in requests.
Indicates if the contact has been verified as per ICANN requirements. If the value is false it indicates that the contact has not completed the required verification process. This property is read-only and will be included in responses but should not be included in requests.
true
Contact contains all relevant contact data for a domain registrant. This schema is used for API responses and may contain null values for legacy data. For creating or updating contacts, use ContactRequest which enforces all validation requirements. Contact contains all relevant contact data for a domain registrant. This schema is used for API responses and may contain null values for legacy data. For creating or updating contacts, use ContactRequest which enforces all validation requirements.
Show child attributes
Show child attributes
First name of the contact. First name of the contact.
"John"
Last name of the contact. Last name of the contact.
"Doe"
Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise. Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise.
"Example Inc."
The first line of the contact's address. The first line of the contact's address.
"123 Main Street"
The second line of the contact's address (optional). The second line of the contact's address (optional).
"Suite 400"
City of the contact's address. City of the contact's address.
"New York"
State or Province of the contact's address. State or Province of the contact's address.
"NY"
ZIP or Postal Code of the contact's address. ZIP or Postal Code of the contact's address.
"10001"
Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code. Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.
"US"
Phone number of the contact. Should follow the E.164 international format: "+[country code][number]". Phone number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15551234567"
Fax number of the contact. Should follow the E.164 international format: "+[country code][number]". Fax number of the contact. Should follow the E.164 international format: "+[country code][number]".
"+15557654321"
Indicates if the contact has been verified as per ICANN requirements. If the value is false it indicates that the contact has not completed the required verification process. This property is read-only and will be included in responses but should not be included in requests.
Indicates if the contact has been verified as per ICANN requirements. If the value is false it indicates that the contact has not completed the required verification process. This property is read-only and will be included in responses but should not be included in requests.
true
The list of nameservers assigned to this domain. If unspecified, it defaults to the account's default nameservers. The list of nameservers assigned to this domain. If unspecified, it defaults to the account's default nameservers.
["ns1.example.com", "ns2.example.com"]The cost to renew the domain. This may be required for the RenewDomain operation. The cost to renew the domain. This may be required for the RenewDomain operation.
12.99
Was this page helpful?