Skip to main content
PUT
Update URLForwarding

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"

host
string<hostname>
required

The full hostname, including subdomain.

Example:

"www.example.org"

Body

application/json

Updated URL forwarding configuration

Fields for updating a URL forwarding entry. Omit a property to leave it unchanged. An empty host string is the apex, not "unchanged".

forwardsTo
string<uri>

The destination URL to which this hostname will be forwarded.

Example:

"https://destination-site.com"

host
string

The subdomain portion of the hostname that is being forwarded. Omit this field to keep the existing host. Send an empty string to move the forwarding to the apex.

Example:

"www"

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"

type
enum<string>

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"

Response

A successful response containing the updated URL forwarding entry.

URLForwarding represents a URL forwarding entry response, 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"

id
integer<int32>

Server-assigned unique identifier for the URL forwarding record. Use this ID with the URL Forwarding by-ID endpoints to get, update, or delete records.

Example:

12345