Domains

Update domain settings

Update domain settings

post/domains/settings/{domainId}

Request

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

Path parameters

domainIdinteger required

Domain ID

Request body

httpsLevel'none' | 'redirect' | 'hsts'
robots'allow' | 'disallow' | 'noindex'
segmentKeystring nullable
posthogProjectApiKeystring nullable
linkType'increment' | 'random' | 'secure' | 'four-char' | 'eight-char' | 'ten-char'
cloakingboolean

Enable cloaking for all links on the domain

hideRefererboolean
hideVisitorIpboolean

Don't store visitor IPs in our database

httpsLinksboolean nullable

Set to null to reissue a certificate

integrationGAstring nullable
integrationFBstring nullable
integrationTTstring nullable
integrationAdrollstring nullable
enableConversionTrackingboolean
qrScanTrackingboolean
preventScraping'none' | 'all'

"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.

integrationGTMstring nullable
clientStorageobject

For internal use

purgeExpiredLinksboolean

[DEPRECATED] do not use

enableAIboolean
caseSensitiveboolean

Enable case sensitivity for short links

Example request

{
  "integrationGTM": "G-1234567"
}

Response

Default Response

successboolean required

Whether the operation succeeded

Example response

{
  "success": true
}

Changes

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