List Domain Subdomains

List all subdomains of a parent domain.

get/account/domains/{domain_id}/subdomains

Request

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

Path parameters

domain_idstring required

Query parameters

limitinteger

Maximum number of results (default 25, max 25)

laststring

Cursor for pagination (last item ID from previous page)

Headers

apikeystring required

API key for authentication

Response

List of subdomains

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.