Domain
A Domain is the host name a short link’s shortUrl is served from (e.g. short.link). Every link is attached to exactly one domain, identified by the link’s domain field.
Key fields
| Field | Description |
|---|---|
id |
UUID identifying the domain. |
domainName |
The host name, e.g. example.com. |
isDefault |
Whether this is the account’s default domain, used when a link is created without an explicit domain. |
isPreferred |
Present only in list responses; whether this is your preferred domain among those available to your account. |
fallbackUrl |
Where visitors are redirected if a short path on this domain isn’t found. Null if unset. |
protocol |
https or http, or null if not yet provisioned. |
externalId |
Your own identifier for the domain, for cross-referencing. |
nsRecords |
Nameserver records associated with the domain, or null. |
status |
Verification/provisioning status — see below. |
Statuses
| Status | Meaning |
|---|---|
| 1 | Verified |
| 2 | Deactivated |
| 3 | Deleted |
| 4 | Pending |
| 5 | Pending nginx |
| 6 | Pending SSL |
Only a domain with status 1 (verified) is guaranteed to be fully live for serving short links.
Related API
See the Domain tag in the API Reference: list domains, with filters for status, creation date, and whether to include default/deleted domains.