URL Forwardings
/
Get URLForwarding

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

URL Forwardings

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

Operations

List URLForwardings

Request

Returns all URL forwarding settings configured for a domain.

Path
domainNamestring(uri)required

DomainName is the domain to list URL forwarding entries for.

Example: example.com
Query
perPageinteger(int32)[ 1 .. 1000 ]

Per Page is the number of records to return per request. Per Page defaults to 1,000.

Default 1000
Example: perPage=100
pageinteger(int32)>= 1

Page is which page to return. Starts at 1 for first page.

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

Responses

A successful response containing the list of URL forwarding entries.

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
lastPageinteger or null(int32)>= 0

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.

Example: 5
nextPageinteger or null(int32)>= 0

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.

Example: 2
urlForwardingArray of objects(URLForwardingResponse)>= 0 itemsrequired

URLForwarding is the list of URL forwarding entries.

Example: []
urlForwarding[].​domainNamestring(hostname)

The domain name (without subdomains) that is being forwarded.

Example: "example.org"
urlForwarding[].​forwardsTostring(uri)required

The destination URL to which this hostname will be forwarded.

Example: "https://destination-site.com"
urlForwarding[].​hoststring(hostname)(The subdomain portion of the hostname)required

The complete hostname that is being forwarded (subdomain + domain).

Example: "www.example.org"
urlForwarding[].​metastring or null

Meta tags to include in the HTML page when using "masked" forwarding. Ignored for other forwarding types. Example: <meta name='keywords' content='fish, denver, platte'>

Example: "<meta name='keywords' content='website, forwarding, masked'>"
urlForwarding[].​titlestring or null

The title to be used for the HTML page when using "masked" forwarding. Ignored for other forwarding types.

Example: "Welcome to my forwarded website"
urlForwarding[].​typestringrequired

The type of URL forwarding. Valid values:

  • masked: Retains the original domain in the address bar, preventing the user from seeing the actual destination URL. Sometimes called iframe forwarding.
  • redirect: Uses a standard HTTP redirect (301), which changes the address bar to the destination URL.
  • 302: Uses a temporary HTTP redirect (302), which changes the address bar to the destination URL but indicates the resource is temporarily located elsewhere.
Enum"masked""redirect""302"
Example: "redirect"
Response
application/json
{
  "lastPage": 5,
  "nextPage": 2,
  "urlForwarding": []
}

Create URLForwarding

Request

Sets up a new URL forwarding (redirect) for a domain or subdomain. If this is the first URL forwarding entry, it may modify the A records for the domain accordingly. Note that changes may take up to 24 hours to fully propagate.

Path
domainNamestring(uri)required

DomainName is the domain part of the hostname to forward.

Example: example.com
Bodyapplication/jsonrequired

URL forwarding details to create

domainNamestring(hostname)

The domain name (without subdomains) that is being forwarded.

Example: "example.org"
forwardsTostring(uri)required

The destination URL to which this hostname will be forwarded.

Example: "https://destination-site.com"
hoststring(The subdomain portion of the hostname)required

The subdomain portion of the hostname that is being forwarded.

Example: "www"
metastring or null

Meta tags to include in the HTML page when using "masked" forwarding. Ignored for other forwarding types. Example: <meta name='keywords' content='fish, denver, platte'>

Example: "<meta name='keywords' content='website, forwarding, masked'>"
titlestring or null

The title to be used for the HTML page when using "masked" forwarding. Ignored for other forwarding types.

Example: "Welcome to my forwarded website"
typestringrequired

The type of URL forwarding. Valid values:

  • masked: Retains the original domain in the address bar, preventing the user from seeing the actual destination URL. Sometimes called iframe forwarding.
  • redirect: Uses a standard HTTP redirect (301), which changes the address bar to the destination URL.
  • 302: Uses a temporary HTTP redirect (302), which changes the address bar to the destination URL but indicates the resource is temporarily located elsewhere.
Enum"masked""redirect""302"
Example: "redirect"
curl -i -X POST \
  -u <username>:<password> \
  https://docs.name.com/_mock/coreapi/namecom.api/core/v1/domains/example.com/url/forwarding \
  -H 'Content-Type: application/json' \
  -d '{
    "domainName": "example.org",
    "forwardsTo": "https://destination-site.com",
    "host": "www",
    "meta": "<meta name='\''keywords'\'' content='\''website, forwarding, masked'\''>",
    "title": "Welcome to my forwarded website",
    "type": "redirect"
  }'

Responses

A successful response containing the created URL forwarding entry.

Bodyapplication/json
domainNamestring(hostname)

The domain name (without subdomains) that is being forwarded.

Example: "example.org"
forwardsTostring(uri)required

The destination URL to which this hostname will be forwarded.

Example: "https://destination-site.com"
hoststring(hostname)(The subdomain portion of the hostname)required

The complete hostname that is being forwarded (subdomain + domain).

Example: "www.example.org"
metastring or null

Meta tags to include in the HTML page when using "masked" forwarding. Ignored for other forwarding types. Example: <meta name='keywords' content='fish, denver, platte'>

Example: "<meta name='keywords' content='website, forwarding, masked'>"
titlestring or null

The title to be used for the HTML page when using "masked" forwarding. Ignored for other forwarding types.

Example: "Welcome to my forwarded website"
typestringrequired

The type of URL forwarding. Valid values:

  • masked: Retains the original domain in the address bar, preventing the user from seeing the actual destination URL. Sometimes called iframe forwarding.
  • redirect: Uses a standard HTTP redirect (301), which changes the address bar to the destination URL.
  • 302: Uses a temporary HTTP redirect (302), which changes the address bar to the destination URL but indicates the resource is temporarily located elsewhere.
Enum"masked""redirect""302"
Example: "redirect"
Response
application/json
{
  "domainName": "example.org",
  "forwardsTo": "https://destination-site.com",
  "host": "www.example.org",
  "meta": "<meta name='keywords' content='website, forwarding, masked'>",
  "title": "Welcome to my forwarded website",
  "type": "redirect"
}

Delete URLForwarding

Request

Removes a URL forwarding configuration from the domain. This operation cannot be undone.

Path
domainNamestring(uri)required

DomainName is the domain to delete the URL forwarding entry from.

Example: example.com
hoststring(hostname)required

The full hostname, including subdomain.

Example: www.example.org
curl -i -X DELETE \
  -u <username>:<password> \
  https://docs.name.com/_mock/coreapi/namecom.api/core/v1/domains/example.com/url/forwarding/www.example.org

Responses

URL Forwarding entry successfully deleted.

Response
No content

Get URLForwarding

Request

Retrieves the details of a specific URL forwarding configuration.

Path
domainNamestring(uri)required

DomainName is the domain to get the URL forwarding entry for.

Example: example.com
hoststring(hostname)required

The full hostname, including subdomain.

Example: www.example.org
curl -i -X GET \
  -u <username>:<password> \
  https://docs.name.com/_mock/coreapi/namecom.api/core/v1/domains/example.com/url/forwarding/www.example.org

Responses

A successful response containing the requested URL forwarding entry.

Bodyapplication/json
domainNamestring(hostname)

The domain name (without subdomains) that is being forwarded.

Example: "example.org"
forwardsTostring(uri)required

The destination URL to which this hostname will be forwarded.

Example: "https://destination-site.com"
hoststring(hostname)(The subdomain portion of the hostname)required

The complete hostname that is being forwarded (subdomain + domain).

Example: "www.example.org"
metastring or null

Meta tags to include in the HTML page when using "masked" forwarding. Ignored for other forwarding types. Example: <meta name='keywords' content='fish, denver, platte'>

Example: "<meta name='keywords' content='website, forwarding, masked'>"
titlestring or null

The title to be used for the HTML page when using "masked" forwarding. Ignored for other forwarding types.

Example: "Welcome to my forwarded website"
typestringrequired

The type of URL forwarding. Valid values:

  • masked: Retains the original domain in the address bar, preventing the user from seeing the actual destination URL. Sometimes called iframe forwarding.
  • redirect: Uses a standard HTTP redirect (301), which changes the address bar to the destination URL.
  • 302: Uses a temporary HTTP redirect (302), which changes the address bar to the destination URL but indicates the resource is temporarily located elsewhere.
Enum"masked""redirect""302"
Example: "redirect"
Response
application/json
{
  "domainName": "example.org",
  "forwardsTo": "https://destination-site.com",
  "host": "www.example.org",
  "meta": "<meta name='keywords' content='website, forwarding, masked'>",
  "title": "Welcome to my forwarded website",
  "type": "redirect"
}

Update URLForwarding

Request

Modifies an existing URL forwarding rule. Changes may take up to 24 hours to fully propagate.

Path
domainNamestring(uri)required

DomainName is the domain part of the hostname to forward.

Example: example.com
hoststring(hostname)required

The full hostname, including subdomain.

Example: www.example.org
Bodyapplication/jsonrequired

Updated URL forwarding configuration

One of:

URLForwarding represents a URL forwarding entry, allowing a domain to redirect to another URL using different forwarding methods.

forwardsTostring(uri)required

The destination URL to which this hostname will be forwarded.

Example: "https://destination-site.com"
metastring or null

Meta tags to include in the HTML page when using "masked" forwarding. Ignored for other forwarding types. Example: <meta name='keywords' content='fish, denver, platte'>

Example: "<meta name='keywords' content='website, forwarding, masked'>"
titlestring or null

The title to be used for the HTML page when using "masked" forwarding. Ignored for other forwarding types.

Example: "Welcome to my forwarded website"
typestringrequired

The type of URL forwarding. Valid values:

  • masked: Retains the original domain in the address bar, preventing the user from seeing the actual destination URL. Sometimes called iframe forwarding.
  • redirect: Uses a standard HTTP redirect (301), which changes the address bar to the destination URL.
  • 302: Uses a temporary HTTP redirect (302), which changes the address bar to the destination URL but indicates the resource is temporarily located elsewhere.
Enum"masked""redirect""302"
Example: "redirect"
curl -i -X PUT \
  -u <username>:<password> \
  https://docs.name.com/_mock/coreapi/namecom.api/core/v1/domains/example.com/url/forwarding/www.example.org \
  -H 'Content-Type: application/json' \
  -d '{
    "forwardsTo": "https://destination-site.com",
    "meta": "<meta name='\''keywords'\'' content='\''website, forwarding, masked'\''>",
    "title": "Welcome to my forwarded website",
    "type": "redirect"
  }'

Responses

A successful response containing the updated URL forwarding entry.

Bodyapplication/json
domainNamestring(hostname)

The domain name (without subdomains) that is being forwarded.

Example: "example.org"
forwardsTostring(uri)required

The destination URL to which this hostname will be forwarded.

Example: "https://destination-site.com"
hoststring(hostname)(The subdomain portion of the hostname)required

The complete hostname that is being forwarded (subdomain + domain).

Example: "www.example.org"
metastring or null

Meta tags to include in the HTML page when using "masked" forwarding. Ignored for other forwarding types. Example: <meta name='keywords' content='fish, denver, platte'>

Example: "<meta name='keywords' content='website, forwarding, masked'>"
titlestring or null

The title to be used for the HTML page when using "masked" forwarding. Ignored for other forwarding types.

Example: "Welcome to my forwarded website"
typestringrequired

The type of URL forwarding. Valid values:

  • masked: Retains the original domain in the address bar, preventing the user from seeing the actual destination URL. Sometimes called iframe forwarding.
  • redirect: Uses a standard HTTP redirect (301), which changes the address bar to the destination URL.
  • 302: Uses a temporary HTTP redirect (302), which changes the address bar to the destination URL but indicates the resource is temporarily located elsewhere.
Enum"masked""redirect""302"
Example: "redirect"
Response
application/json
{
  "domainName": "example.org",
  "forwardsTo": "https://destination-site.com",
  "host": "www.example.org",
  "meta": "<meta name='keywords' content='website, forwarding, masked'>",
  "title": "Welcome to my forwarded website",
  "type": "redirect"
}

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