Custom hostnames

Configure and manage custom hostnames for your docs sites.

Get the details about a custom hostname.

get

Authorizations

Path parameters

hostnamestringrequired

The custom hostname, for example "docs.gitbook.com"

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gitbook.com/v1/custom-hostnames/{hostname}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

200

{
  "object": "custom-hostname",
  "hostname": "text",
  "target": {
    "type": "organization",
    "organization": "text"
  },
  "isActive": true,
  "status": "text",
  "urls": {
    "location": "https://example.com"
  }
}

OK

Remove a custom hostname from a content or organization. The custom hostname will continue to point to the content or organization unless it is used for another one.

delete

Authorizations

Path parameters

hostnamestringrequired

The custom hostname, for example "docs.gitbook.com"

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.gitbook.com/v1/custom-hostnames/{hostname}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

205

default

205

No body

Custom hostname has been removed

Revalidate a custom hostname's DNS records and status.

patch

Authorizations

Path parameters

hostnamestringrequired

The custom hostname, for example "docs.gitbook.com"

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.gitbook.com/v1/custom-hostnames/{hostname}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

400

409

default

204

No body

DNS validation has been retriggered