Skip to main content
GET
/
core
/
v1
/
urlforwarding
/
{domainName}
List URL Forwardings by domain
curl --request GET \
  --url https://api.dev.name.com/core/v1/urlforwarding/{domainName} \
  --header 'Authorization: Basic <encoded-value>'
import requests

url = "https://api.dev.name.com/core/v1/urlforwarding/{domainName}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.dev.name.com/core/v1/urlforwarding/{domainName}', 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/urlforwarding/{domainName}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.dev.name.com/core/v1/urlforwarding/{domainName}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Basic <encoded-value>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.dev.name.com/core/v1/urlforwarding/{domainName}")
.header("Authorization", "Basic <encoded-value>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.dev.name.com/core/v1/urlforwarding/{domainName}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body
{
  "urlForwarding": [],
  "lastPage": 5,
  "nextPage": 2
}
{
"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": "Rate Limit Exceeded"
}
{
"message": "Internal Server Error",
"details": "Something went wrong."
}
{
"message": "The server received an invalid response from the upstream server."
}
{
"message": "The upstream server is taking too long to respond."
}

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 to list URL forwarding entries for. The domain must be owned by the authenticated account.

Example:

"example.com"

Query Parameters

perPage
integer<int32>
default:500

Per Page is the number of records to return per request. Per Page defaults to 500. Maximum number of records to return per page for paginated list endpoints.

Required range: 1 <= x <= 1000
Example:

100

page
integer<int32>
default:1

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

Required range: x >= 1
Example:

1

Response

A successful response containing the list of URL forwarding entries.

ListURLForwardingsResponse is the response for the ListURLForwardings function.

urlForwarding
object[]
required

URLForwarding is the list of URL forwarding entries.

Example:
[]
lastPage
integer<int32> | null

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.

Required range: x >= 0
Example:

5

nextPage
integer<int32> | null

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.

Required range: x >= 0
Example:

2