Subdomains
Manage and configure organization-specific subdomains for your docs.
Provide a branded subdomain for each organization to create a consistent user experience. This API supports subdomain creation, DNS checks, and more.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
subdomainstring · min: 3 · max: 32RequiredPattern:
The subdomain, for example "my-company" in "my-company.gitbook.io"
^[a-z0-9][a-z0-9-]{1,30}[a-z0-9]$Responses
200
OK
application/json
objectstring · enumRequiredPossible values:
subdomainstring · min: 3 · max: 32RequiredPattern:
The GitBook subdomain, for example "my-company" in "my-company.gitbook.io"
^[a-z0-9][a-z0-9-]{1,30}[a-z0-9]$targetone ofRequired
isActivebooleanRequired
get/subdomains/{subdomain}
200
OK
Last updated
Was this helpful?