Domains
/
Get Auth Code For Domain

Name.com Core API (1.0.1)

RESTful API for managing domains, DNS records, and related services at Name.com. Access via HTTPS at api.name.com (production) or api.dev.name.com (testing). Supports standard authentication, rate-limited to 20 requests/second.

Download OpenAPI description
namecom.api.json
namecom.api.yaml
Overview
Account Services

accountservices@name.com

Terms of Service

Languages
Servers
Mock server

https://docs.name.com/_mock/coreapi/namecom.api/

Testing

https://api.dev.name.com/

Hello

Use the Hello endpoint to verify that your API connection and credentials are working properly. This simple call returns a success message (along with server time and version info) to confirm the API is reachable and authenticated.

Operations

Account Info

Use Account Info endpoints to retrieve basic information about your Name.com account. For example, you can check your account’s current credit balance and other account details using these endpoints.

Operations

Accounts

Use Accounts endpoints (available upon request) to manage sub-accounts under your main account. For example, resellers can programmatically create new customer accounts with their own login credentials and permissions.

Operations

Domains

Use Domains endpoints to search for domain availability, register new domains, and manage existing domains.

Operations

Update a domain

Request

Allows updating of the autorenew, WhoIs Privacy and lock status of the specified domain. The request requires one, or any combination of the parameters in order to pass validation. If any of the requested updates failed, the domain will be returned to it's original state.

Path
domainNamestringrequired

DomainName is the domain to update.

Bodyapplication/json
Any of:
autorenewEnabledbooleanrequired

Enable or disable automatic renewal for the domain.

Example: true
privacyEnabledboolean

Enable or disable Whois privacy for the domain.

Example: true
lockedboolean

Set the transfer lock status for the domain

Example: true
curl -i -X PATCH \
  -u <username>:<password> \
  'https://docs.name.com/_mock/coreapi/namecom.api/core/v1/domains/{domainName}' \
  -H 'Content-Type: application/json' \
  -d '{
    "autorenewEnabled": true,
    "privacyEnabled": true,
    "locked": true
  }'

Responses

A successful response will return the updated domain.

Bodyapplication/json
domainNamestringrequired

The punycode-encoded value of the domain name.

Example: "example.com"
createDatestring(date-time)read-onlyrequired

The date and time when the domain was created at the registry.

Example: "2023-01-15T14:30:00Z"
expireDatestring(date-time)read-onlyrequired

The date and time when the domain will expire.

Example: "2025-01-15T14:30:00Z"
autorenewEnabledbooleanrequired

Indicates whether the domain is set to renew automatically before expiration.

Example: true
lockedbooleanrequired

Indicates if the domain is locked, preventing transfers to another registrar.

Example: true
privacyEnabledbooleanrequired

Indicates if Whois Privacy is enabled for this domain.

Example: true
contactsobject(Contacts)required

Contacts stores the contact information for the roles related to domains.

contacts.​adminobject(Contact)

Contact contains all relevant contact data for a domain registrant.

contacts.​billingobject(Contact)

Contact contains all relevant contact data for a domain registrant.

contacts.​registrantobject(Contact)

Contact contains all relevant contact data for a domain registrant.

contacts.​techobject(Contact)

Contact contains all relevant contact data for a domain registrant.

nameserversArray of stringsrequired

The list of nameservers assigned to this domain. If unspecified, it defaults to the account's default nameservers.

Example: ["ns1.example.com","ns2.example.com"]
renewalPricenumber(double)read-onlyrequired

The cost to renew the domain. This may be required for the RenewDomain operation.

Example: 12.99
Response
application/json
{
  "domainName": "example.com",
  "createDate": "2023-01-15T14:30:00Z",
  "expireDate": "2025-01-15T14:30:00Z",
  "autorenewEnabled": true,
  "locked": true,
  "privacyEnabled": true,
  "contacts": {
    "admin": { … },
    "billing": { … },
    "registrant": { … },
    "tech": { … }
  },
  "nameservers": [
    "ns1.example.com",
    "ns2.example.com"
  ],
  "renewalPrice": 12.99
}

Get Auth Code For Domain

Request

Retrieves the transfer authorization code (EPP code) for a domain.

Path
domainNamestringrequired

DomainName is the domain name to retrieve the authorization code for.

curl -i -X GET \
  -u <username>:<password> \
  'https://docs.name.com/_mock/coreapi/namecom.api/core/v1/domains/{domainName}:getAuthCode'

Responses

A successful response.

Bodyapplication/json
authCodestringrequired

AuthCode is the authorization code needed to transfer a domain to another registrar. If you are storing auth codes, be sure to store them in a secure manner.

Response
application/json
{
  "authCode": "string"
}

Get Pricing For Domain

Request

Retrieves the registration and renewal pricing for a given domain.

Path
domainNamestringrequired

DomainName is the domain to retrieve.

Query
yearsinteger(int32)

Years specifies the time period in years to get pricing for the domain. Years defaults to the minimum time period (typically 1 year) if not passed and cannot be more than 10. Some TLDs default to longer periods (e.g. .AI requires 2 year periods).

Example: years=2
curl -i -X GET \
  -u <username>:<password> \
  'https://docs.name.com/_mock/coreapi/namecom.api/core/v1/domains/{domainName}:getPricing?years=2'

Responses

A successful response.

Bodyapplication/json
premiumbooleanrequired

Premium indicates that this pricing is a premium result and the respective prices must be passed in create, renew or transfer commands.

purchasePricenumber(double)required

PurchasePrice is the price you will pay to register a domain. Can be passed in the CreateDomain request.

Example: 24.99
renewalPricenumber(double)required

RenewalPrice is the price you will pay to renew a domain. Can be passed in the RenewDomain request.

Example: 24.99
transferPricenumber(double)required

TransferPrice is the price you will pay to transfer a domain. Can be passed in the CreateTransfer request. The TransferPrice is always for 1 year regardless of the years input.

Example: 24.99
Response
application/json
{
  "premium": true,
  "purchasePrice": 24.99,
  "renewalPrice": 24.99,
  "transferPrice": 24.99
}

DNS

Use DNS endpoints to manage DNS records for your domains. You can list all existing DNS records for a domain and create, update, or delete records as needed.

Operations

DNSSECs

Use DNSSEC endpoints to configure DNS Security Extensions for your domains. These endpoints allow you to add, retrieve, or remove DNSSEC records.

Operations

Email Forwardings

Use Email Forwardings endpoints to set up and manage email forwarding addresses on your domains.

Operations

URL Forwardings

Use URL Forwardings endpoints to control URL redirection settings for your domains.

Operations

Vanity Nameservers

Use Vanity Nameservers endpoints to configure custom nameserver hostnames (glue records) for your domains.

Operations

Transfers

Use Transfers endpoints to move domains into your Name.com account. Start by creating a transfer request, then monitor and manage the status of pending transfers. You can also cancel a transfer if needed.

Operations

Orders

Use Orders endpoints to review and track purchases made via the API.

Operations

Webhook Notifications

Use Webhook Notification endpoints to subscribe to real-time notifications for account and domain events. This keeps your application updated on important changes without polling the API.

OperationsWebhooks