Email Forwardings

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

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

List Email Forwardings

Request

Returns a paginated list of all email forwarding rules for a domain.

Path
domainNamestringrequired

DomainName is the domain to list email forwarded boxes for.

Query
perPageinteger(int32)

(optional) Per Page is the number of records to return per request. Per Page defaults to 1,000 if not set.

Example: perPage=100
pageinteger(int32)

(optional) Page is which page to return. Default to page 1 if not set.

Example: page=1
curl -i -X GET \
  -u <username>:<password> \
  'https://docs.name.com/_mock/coreapi/namecom.api/core/v1/domains/{domainName}/email/forwarding?page=1&perPage=100'

Responses

A successful response.

Headers
Linkstring

String delimited list of links for pagination

Example: "<https://api.dev.name.com?page=3; rel=\"next\">,<https://api.dev.name.com?page=1; rel=\"prev\">,<https://api.dev.name.com?page=10; rel=\"last\">"
Bodyapplication/json
emailForwardingArray of objects(EmailForwarding)required

EmailForwarding is the list of forwarded email boxes.

emailForwarding[].​domainNamestringrequired

DomainName is the domain part of the email address to forward.

Example: "example.com"
emailForwarding[].​emailBoxstringrequired

EmailBox is the user portion of the email address to forward.

Example: "admin"
emailForwarding[].​emailTostringrequired

EmailTo is the entire email address to forward email to.

Example: "webmaster@example.com"
lastPageinteger(int32)

LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.

nextPageinteger(int32)

NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.

Response
application/json
{
  "emailForwarding": [
    { … }
  ],
  "lastPage": 0,
  "nextPage": 0
}

Create Email Forwarding

Request

Creates a new email forwarding rule for a domain, such as redirecting info@example.com to an external inbox. If this is the first email forwarding rule created for the domain, the API may also update your MX records automatically to enable mail routing. The alias must not conflict with existing email services or MX records. To modify a forwarding rule later, use UpdateEmailForwarding.

Path
domainNamestringrequired

DomainName is the domain part of the email address to forward.

Example: example.com
Bodyapplication/jsonrequired
emailBoxstringrequired

EmailBox is the user portion of the email address to forward. If your email is "admin@example.com", it would just be "admin"

Example: "admin"
emailTostringrequired

EmailTo is the entire email address to forward email to.

Example: "webmaster@example.com"
curl -i -X POST \
  -u <username>:<password> \
  https://docs.name.com/_mock/coreapi/namecom.api/core/v1/domains/example.com/email/forwarding \
  -H 'Content-Type: application/json' \
  -d '{
    "emailBox": "admin",
    "emailTo": "webmaster@example.com"
  }'

Responses

An email forwarding record has been successfully created.

Bodyapplication/json
domainNamestringrequired

DomainName is the domain part of the email address to forward.

Example: "example.com"
emailBoxstringrequired

EmailBox is the user portion of the email address to forward.

Example: "admin"
emailTostringrequired

EmailTo is the entire email address to forward email to.

Example: "webmaster@example.com"
Response
application/json
{
  "domainName": "example.com",
  "emailBox": "admin",
  "emailTo": "webmaster@example.com"
}

Delete Email Forwarding

Request

Deletes an email forwarding rule from a domain.

Path
domainNamestringrequired

DomainName is the domain to delete the email forwarded box from.

emailBoxstringrequired

EmailBox is which email box to delete.

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

Responses

Email Forwarding entry successfully deleted.

Response
No content

Get Email Forwarding

Request

Retrieves the details of a specific email forwarding entry.

Path
domainNamestringrequired

DomainName is the domain to list email forwarded box for.

emailBoxstringrequired

EmailBox is which email box to retrieve.

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

Responses

A successful response.

Bodyapplication/json
domainNamestringrequired

DomainName is the domain part of the email address to forward.

Example: "example.com"
emailBoxstringrequired

EmailBox is the user portion of the email address to forward.

Example: "admin"
emailTostringrequired

EmailTo is the entire email address to forward email to.

Example: "webmaster@example.com"
Response
application/json
{
  "domainName": "example.com",
  "emailBox": "admin",
  "emailTo": "webmaster@example.com"
}

Update Email Forwarding

Request

Updates the destination email address for an existing forwarding rule.

Path
domainNamestringrequired

DomainName is the domain part of the email address to forward.

emailBoxstringrequired

EmailBox is the user portion of the email address to forward.

Bodyapplication/jsonrequired
emailTostring

EmailTo is the entire email address to forward email to.

curl -i -X PUT \
  -u <username>:<password> \
  'https://docs.name.com/_mock/coreapi/namecom.api/core/v1/domains/{domainName}/email/forwarding/{emailBox}' \
  -H 'Content-Type: application/json' \
  -d '{
    "emailTo": "string"
  }'

Responses

A successful response.

Bodyapplication/json
domainNamestringrequired

DomainName is the domain part of the email address to forward.

Example: "example.com"
emailBoxstringrequired

EmailBox is the user portion of the email address to forward.

Example: "admin"
emailTostringrequired

EmailTo is the entire email address to forward email to.

Example: "webmaster@example.com"
Response
application/json
{
  "domainName": "example.com",
  "emailBox": "admin",
  "emailTo": "webmaster@example.com"
}

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