Domains

Create a domain

post/domains

Request

  • Base URL: https://api.short.io
  • URL: https://api.short.io/domains
  • Auth: API key in header Authorization

Request body

hostnamestring idn-hostname required

Domain hostname

hideRefererboolean

Strip referer header on redirect

linkType'increment' | 'random' | 'secure' | 'four-char' | 'eight-char' | 'ten-char'

Default link type for the domain

teamIdinteger

Team to create the domain in. Required for non-admin organization members; optional for organization admins.

Example request

{
  "hostname": "😀.link",
  "hideReferer": true,
  "teamId": 12345
}

Response

Default Response

idinteger required

Domain ID

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
TeamIdinteger nullable
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

Example response

{
  "id": 12345
}

Changes

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