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 @- <<EOF
{
"forwardsTo": "https://destination-site.com",
"host": "www",
"type": "redirect",
"meta": "<meta name='keywords' content='website, forwarding, masked'>",
"title": "Welcome to my forwarded website"
}
EOFimport requests
url = "https://api.dev.name.com/core/v1/domains/{domainName}/url/forwarding"
payload = {
"forwardsTo": "https://destination-site.com",
"host": "www",
"type": "redirect",
"meta": "<meta name='keywords' content='website, forwarding, masked'>",
"title": "Welcome to my forwarded website"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
forwardsTo: 'https://destination-site.com',
host: 'www',
type: 'redirect',
meta: '<meta name=\'keywords\' content=\'website, forwarding, masked\'>',
title: 'Welcome to my forwarded website'
})
};
fetch('https://api.dev.name.com/core/v1/domains/{domainName}/url/forwarding', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.dev.name.com/core/v1/domains/{domainName}/url/forwarding",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'forwardsTo' => 'https://destination-site.com',
'host' => 'www',
'type' => 'redirect',
'meta' => '<meta name=\'keywords\' content=\'website, forwarding, masked\'>',
'title' => 'Welcome to my forwarded website'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.dev.name.com/core/v1/domains/{domainName}/url/forwarding"
payload := strings.NewReader("{\n \"forwardsTo\": \"https://destination-site.com\",\n \"host\": \"www\",\n \"type\": \"redirect\",\n \"meta\": \"<meta name='keywords' content='website, forwarding, masked'>\",\n \"title\": \"Welcome to my forwarded website\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.dev.name.com/core/v1/domains/{domainName}/url/forwarding")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"forwardsTo\": \"https://destination-site.com\",\n \"host\": \"www\",\n \"type\": \"redirect\",\n \"meta\": \"<meta name='keywords' content='website, forwarding, masked'>\",\n \"title\": \"Welcome to my forwarded website\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dev.name.com/core/v1/domains/{domainName}/url/forwarding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"forwardsTo\": \"https://destination-site.com\",\n \"host\": \"www\",\n \"type\": \"redirect\",\n \"meta\": \"<meta name='keywords' content='website, forwarding, masked'>\",\n \"title\": \"Welcome to my forwarded website\"\n}"
response = http.request(request)
puts response.read_body{
"forwardsTo": "https://destination-site.com",
"host": "www",
"type": "redirect",
"domainName": "example.org",
"meta": "<meta name='keywords' content='website, forwarding, masked'>",
"title": "Welcome to my forwarded website",
"id": 12345
}{
"message": "Bad Request",
"details": "'domainName' cannot be null"
}{
"message": "Unauthorized"
}{
"message": "Permission denied",
"details": "Failed authentication"
}{
"message": "Not Found",
"details": "The requested domain does not exist."
}{
"message": "Method Not Allowed"
}{
"message": "Object already exists.",
"details": "Cannot create multiple objects under same key."
}{
"message": "The 'Content-Type' header must be 'application/json' for this request."
}{
"message": "Rate Limit Exceeded"
}{
"message": "Internal Server Error",
"details": "Something went wrong."
}{
"message": "The server received an invalid response from the upstream server."
}{
"message": "Service Unavailable",
"details": "The API is offline for scheduled maintenance. See https://status.name.com for updates."
}{
"message": "The upstream server is taking too long to respond."
}Create URLForwarding
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.
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 @- <<EOF
{
"forwardsTo": "https://destination-site.com",
"host": "www",
"type": "redirect",
"meta": "<meta name='keywords' content='website, forwarding, masked'>",
"title": "Welcome to my forwarded website"
}
EOFimport requests
url = "https://api.dev.name.com/core/v1/domains/{domainName}/url/forwarding"
payload = {
"forwardsTo": "https://destination-site.com",
"host": "www",
"type": "redirect",
"meta": "<meta name='keywords' content='website, forwarding, masked'>",
"title": "Welcome to my forwarded website"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
forwardsTo: 'https://destination-site.com',
host: 'www',
type: 'redirect',
meta: '<meta name=\'keywords\' content=\'website, forwarding, masked\'>',
title: 'Welcome to my forwarded website'
})
};
fetch('https://api.dev.name.com/core/v1/domains/{domainName}/url/forwarding', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.dev.name.com/core/v1/domains/{domainName}/url/forwarding",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'forwardsTo' => 'https://destination-site.com',
'host' => 'www',
'type' => 'redirect',
'meta' => '<meta name=\'keywords\' content=\'website, forwarding, masked\'>',
'title' => 'Welcome to my forwarded website'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.dev.name.com/core/v1/domains/{domainName}/url/forwarding"
payload := strings.NewReader("{\n \"forwardsTo\": \"https://destination-site.com\",\n \"host\": \"www\",\n \"type\": \"redirect\",\n \"meta\": \"<meta name='keywords' content='website, forwarding, masked'>\",\n \"title\": \"Welcome to my forwarded website\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.dev.name.com/core/v1/domains/{domainName}/url/forwarding")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"forwardsTo\": \"https://destination-site.com\",\n \"host\": \"www\",\n \"type\": \"redirect\",\n \"meta\": \"<meta name='keywords' content='website, forwarding, masked'>\",\n \"title\": \"Welcome to my forwarded website\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dev.name.com/core/v1/domains/{domainName}/url/forwarding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"forwardsTo\": \"https://destination-site.com\",\n \"host\": \"www\",\n \"type\": \"redirect\",\n \"meta\": \"<meta name='keywords' content='website, forwarding, masked'>\",\n \"title\": \"Welcome to my forwarded website\"\n}"
response = http.request(request)
puts response.read_body{
"forwardsTo": "https://destination-site.com",
"host": "www",
"type": "redirect",
"domainName": "example.org",
"meta": "<meta name='keywords' content='website, forwarding, masked'>",
"title": "Welcome to my forwarded website",
"id": 12345
}{
"message": "Bad Request",
"details": "'domainName' cannot be null"
}{
"message": "Unauthorized"
}{
"message": "Permission denied",
"details": "Failed authentication"
}{
"message": "Not Found",
"details": "The requested domain does not exist."
}{
"message": "Method Not Allowed"
}{
"message": "Object already exists.",
"details": "Cannot create multiple objects under same key."
}{
"message": "The 'Content-Type' header must be 'application/json' for this request."
}{
"message": "Rate Limit Exceeded"
}{
"message": "Internal Server Error",
"details": "Something went wrong."
}{
"message": "The server received an invalid response from the upstream server."
}{
"message": "Service Unavailable",
"details": "The API is offline for scheduled maintenance. See https://status.name.com for updates."
}{
"message": "The upstream server is taking too long to respond."
}Authorizations
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 is the domain part of the hostname to forward.
"example.com"
Body
URL forwarding details to create
Fields for creating a URL forwarding entry.
The destination URL to which this hostname will be forwarded.
"https://destination-site.com"
The subdomain portion of the hostname that is being forwarded. Use an empty string for the apex.
"www"
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.
masked, redirect, 302 "redirect"
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'>
"<meta name='keywords' content='website, forwarding, masked'>"
The title to be used for the HTML page when using "masked" forwarding. Ignored for other forwarding types.
"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.
The destination URL to which this hostname will be forwarded.
"https://destination-site.com"
The subdomain portion of the hostname that is being forwarded.
"www"
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.
masked, redirect, 302 "redirect"
The domain name (without subdomains) that is being forwarded.
"example.org"
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'>
"<meta name='keywords' content='website, forwarding, masked'>"
The title to be used for the HTML page when using "masked" forwarding. Ignored for other forwarding types.
"Welcome to my forwarded website"
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.
12345
Was this page helpful?