hostnamestring hostname required
unicodeHostnamestring fqdn required
state'extra_records' | 'not_registered' | 'configured' | 'not_configured' | 'registration_pending' | 'not_verified' required
createdAtstring date-time required
updatedAtstring date-time required
OrganizationIdstring uuid nullable
hasFaviconboolean required
faviconURLstring uri nullable required
segmentKeystring nullable
posthogProjectApiKeystring nullable
posthogHoststring iri nullable
hideRefererboolean required
linkType'increment' | 'random' | 'secure' | 'four-char' | 'eight-char' | 'ten-char' required
cloakingboolean required
Enable cloaking for all links on the domain
hideVisitorIpboolean required
Don't store visitor IPs in our database
enableAIboolean required
Enable AI for all links on the domain
httpsLevel'none' | 'redirect' | 'hsts' required
httpsLinksboolean nullable required
webhookURLstring iri nullable
integrationGAstring nullable
integrationFBstring nullable
integrationTTstring nullable
integrationAdrollstring nullable
integrationGTMstring nullable
clientStorageobject nullable required
caseSensitiveboolean required
incrementCounterstring required
robots'allow' | 'disallow' | 'noindex' required
sslCertExpirationDatestring date-time nullable
sslCertInstalledSuccessboolean nullable
domainRegistrationIdinteger nullable
registrationExpiresAtstring date-time nullable
When the registration of a domain bought through us expires, null for external domains
registrationAutoRenewboolean nullable
Whether the registration renews itself before it expires, null for external domains. When true, an upcoming expiry needs no action from the customer
exportEnabledboolean required
enableConversionTrackingboolean required
qrScanTrackingboolean required
preventScraping'none' | 'all' required
"all" requires every visitor to pass a proof-of-work check before the link resolves. That blocks scrapers, and also link previews, crawlers and any other client that does not run JavaScript.
dnsConfigDeprecatedboolean required
ipExclusionsstring[] required
IP addresses excluded from click tracking
userPlan'tiny' | 'hobby' | 'small' | 'standard' | 'large' required
Plan type of the domain owner
linkSignatureKeyLast4string nullable required
Last 4 characters of the domain's link-signature key, or null when signing is disabled. The full key is only returned when it is rotated.