Custom hostnames
Serve your GitBook content from fully branded, custom hostnames.
Extend your brand identity by mapping personalized domain names to your docs. This can help unify your documentation site with your existing company properties.
Attributes
objectstring · enumRequiredPossible values:
hostnamestring · max: 512RequiredPattern:
Custom hostname for the site, for e.g. docs.mycompany.com
^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?[.]){2,}[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$
targetone ofRequired
or
isActivebooleanRequired
statusone ofOptional
string · enumOptionalPossible values:
The CustomHostname object
The custom hostname will continue to point to the content or organization unless it is used for another one.
Authorizations
Path parameters
hostnamestringRequired
The custom hostname, for example "docs.gitbook.com"
Responses
delete
205
Custom hostname has been removed
No content
Was this helpful?