Sign in

v1

latestOpenAPI 3.1.02026-07-2671111437.2 KB
URL Forwardings

Update URL Forwarding by ID

Modifies an existing URL forwarding rule by ID. The domain must be owned by the authenticated account. Changes may take up to 24 hours to fully propagate.

patch/core/v1/urlforwarding/{domainName}/{id}

Path parameters

domainNamestring hostname required
Example:example.com

DomainName is the domain that owns the URL forwarding entry. Must be owned by the authenticated account.

idinteger required
Example:12345

ID is the server-assigned unique identifier for the URL forwarding record (returned in list responses).

Request body

forwardsTostring uri required

The destination URL to which this hostname will be forwarded.

hoststring required

The subdomain portion of the hostname that is being forwarded.

metastring nullable

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'>

titlestring nullable

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

type'masked' | 'redirect' | '302' 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.

Example request

{
  "forwardsTo": "https://destination-site.com",
  "host": "www",
  "meta": "<meta name='keywords' content='website, forwarding, masked'>",
  "title": "Welcome to my forwarded website",
  "type": "redirect"
}

Response

A successful response containing the updated URL forwarding entry.

domainNamestring hostname

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

forwardsTostring uri required

The destination URL to which this hostname will be forwarded.

hoststring required

The subdomain portion of the hostname that is being forwarded.

metastring nullable

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'>

titlestring nullable

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

type'masked' | 'redirect' | '302' 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.
idinteger

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 response

{
  "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",
  "id": 12345
}