Get a custom hostname

get

Authorizations

user-internaluser-staff

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

hostnamestringRequired

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

Responses

200

OK

application/json

objectstring · enumRequiredPossible values:

hostnamestring · max: 512Required

Custom hostname for the site, for e.g. docs.mycompany.com

Pattern: ^([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:

get/custom-hostnames/{hostname}

HTTPcURLJavaScriptPython

GET /v1/custom-hostnames/{hostname} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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