Custom hostnames
Serve your GitBook content from fully branded, custom hostnames.
Was this helpful?
Serve your GitBook content from fully branded, custom hostnames.
Was this helpful?
Was this helpful?
Extend your brand identity by mapping personalized domain names to your docs. This can help unify your documentation site with your existing company properties.
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]$The custom hostname will continue to point to the content or organization unless it is used for another one.
The custom hostname, for example "docs.gitbook.com"
Custom hostname did not exist
Custom hostname has been removed
No content
Revalidate DNS records and status.
The custom hostname, for example "docs.gitbook.com"
DNS validation has been retriggered
The current custom hostname is inactive and cannot be revalidated
The current custom hostname status does not allow DNS revalidation
No content
{
"object": "custom-hostname",
"hostname": "text",
"target": {
"type": "organization",
"organization": "text"
},
"isActive": true,
"status": "text",
"urls": {
"location": "https://example.com"
}
}GET /v1/custom-hostnames/{hostname} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"object": "custom-hostname",
"hostname": "text",
"target": {
"type": "organization",
"organization": "text"
},
"isActive": true,
"status": "text",
"urls": {
"location": "https://example.com"
}
}DELETE /v1/custom-hostnames/{hostname} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
PATCH /v1/custom-hostnames/{hostname} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*