Skip to main content
GET
/
core
/
v1
/
domains
/
{domainName}
/
url
/
forwarding
List URLForwardings
curl --request GET \
  --url https://api.dev.name.com/core/v1/domains/{domainName}/url/forwarding \
  --header 'Authorization: Basic <encoded-value>'
{
  "lastPage": 5,
  "nextPage": 2,
  "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 to list URL forwarding entries for.

Example:

"example.com"

Query Parameters

​
perPage
integer
default:1000

Per Page is the number of records to return per request. Per Page defaults to 1,000.

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

100

​
page
integer
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 | 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 | 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

⌘I