Subdomains

Configure and manage subdomains for your organization.

Get the details about a subdomain.

get

Authorizations

Path parameters

subdomainstring · min: 3 · max: 32required

The subdomain, for example "my-company" in "my-company.gitbook.io"

Pattern: ^[a-z0-9][a-z0-9-]{1,30}[a-z0-9]$

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "object": "subdomain",
  "subdomain": "text",
  "target": {
    "type": "organization",
    "organization": "text"
  },
  "isActive": true
}

OK