RErebrandly
Account
Domains

Create Domain

Register a new domain for the account.

Features:

  • domains.whitelabeled.fallback: Required for custom404
  • domains.whitelabeled.homepage: Required for customHomepage
  • domains.validation.skip: Skip TLD validation
post/account/domains

Request

  • Base URL
    https://api.rebrandly.com/v1
  • URL
    https://api.rebrandly.com/v1/account/domains
  • Auth
    API key in header apikey

Headers

apikeystring required

API key for authentication

Request body

fullNamestring required

Full domain name

custom404string uri

Custom 404 page URL (requires feature)

customHomepagestring uri

Custom homepage URL (requires feature)

httpsboolean

Enable HTTPS

providerstring

Domain provider

nameserversstring[]

Custom nameservers

Example request

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

Response

Domain created

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.