Account

Domains

Set Domain Homepage Routing

Configure custom homepage routing for the domain.

Feature Required: domains.whitelabeled.homepage

post/account/domains/{domain_id}/routing/homepage

Request

Base URL
https://api.rebrandly.com/v1
URL
https://api.rebrandly.com/v1/account/domains/{domain_id}/routing/homepage
Auth
API key in header apikey

Path parameters

domain_idstring required

Headers

apikeystring required

API key for authentication

Request body

urlstring uri required

Homepage destination URL

policy'redirect' | 'frame'

Routing policy

Response

Homepage routing configured

idstring required

Domain public ID (32 characters)

fullNamestring required

Full domain name

topLevelDomainstring

Top-level domain

type'USER' | 'SYSTEM'

Domain type (USER = custom, SYSTEM = rebrandly provided)

ownerIdstring

Owner account public ID

providerstring

Domain provider name

levelinteger

Domain hierarchy level (1 = root domain)

managedboolean

Whether domain is managed by Rebrandly

httpsboolean

Whether HTTPS is enabled

subdomainsinteger

Number of subdomains

nameserversstring[]

DNS nameservers

autorenewboolean

Whether auto-renewal is enabled

createdAtstring date-time

updatedAtstring date-time

Example response

{
  "fullName": "my-brand.ly",
  "topLevelDomain": "ly"
}

Changes

No recorded changes to this operation across all 1 revision of this API.