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.
Attributes
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
The Subdomain object
{
"object": "subdomain",
"subdomain": "text",
"target": {
"type": "organization",
"organization": "text"
},
"isActive": true
}Authorizations
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
get
/subdomains/{subdomain}GET /v1/subdomains/{subdomain} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
OK
{
"object": "subdomain",
"subdomain": "text",
"target": {
"type": "organization",
"organization": "text"
},
"isActive": true
}Last updated
Was this helpful?