Skip to main content
POST
/
core
/
v1
/
domains
/
{domainName}
/
url
/
forwarding
Create URLForwarding
curl --request POST \
  --url https://api.dev.name.com/core/v1/domains/{domainName}/url/forwarding \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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"
}'
{
  "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"
}

Authorizations

​
Authorization
string
header
required

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.

Path Parameters

​
domainName
string<hostname>
required

DomainName is the domain part of the hostname to forward.

Example:

"example.com"

Body

application/json

URL forwarding details to create

The request body for creating a new URL forwarding entry. URLForwarding represents a URL forwarding entry, allowing a domain to redirect to another URL using different forwarding methods.

​
forwardsTo
string<uri>
required

The destination URL to which this hostname will be forwarded.

Example:

"https://destination-site.com"

​
host
string
required

The subdomain portion of the hostname that is being forwarded.

Example:

"www"

​
type
enum<string>
required

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.
Available options:
masked,
redirect,
302
Example:

"redirect"

​
domainName
string<hostname>

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

Example:

"example.org"

​
meta
string | 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'>"

​
title
string | 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"

Response

A successful response containing the created URL forwarding entry.

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

​
forwardsTo
string<uri>
required

The destination URL to which this hostname will be forwarded.

Example:

"https://destination-site.com"

​
host
string<hostname>
required

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

Example:

"www.example.org"

​
type
enum<string>
required

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.
Available options:
masked,
redirect,
302
Example:

"redirect"

​
domainName
string<hostname>

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

Example:

"example.org"

​
meta
string | 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'>"

​
title
string | 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"

⌘I