v1

latestOpenAPI 3.1.02026-07-2671111437.2 KB

URL Forwardings

List URL Forwardings by domain

Returns all URL forwarding settings configured for a domain. Each entry includes an id that can be used with the URL Forwarding by-ID endpoints to get, update, or delete records.

get/core/v1/urlforwarding/{domainName}

Path parameters

domainNamestring hostname required

Example:example.com

DomainName is the domain to list URL forwarding entries for. The domain must be owned by the authenticated account.

Query parameters

perPageinteger

Maximum number of records to return per page for paginated list endpoints.

Example:100

Per Page is the number of records to return per request. Per Page defaults to 500.

pageinteger

Example:1

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

Response

A successful response containing the list of URL forwarding entries.

lastPageinteger nullable

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.

nextPageinteger nullable

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.

Example response

{
  "lastPage": 5,
  "nextPage": 2,
  "urlForwarding": []
}