URLs
Configure where and how your GitBook content can be accessed.
Was this helpful?
Configure where and how your GitBook content can be accessed.
Was this helpful?
Was this helpful?
Manage official endpoints, direct deep links, or short links for your content. This allows you to keep track of multiple custom URLs or vanity links under one system.
URL to resolve
JWT token generated for a authenticated access session
When true redirects the user to the authentication/fallback URL if the access token is invalid
falseOK
No content found for the URL.
URL to resolve
When true redirects the user to the authentication/fallback URL if the access token is invalid
falseOK
No content found for the URL.
OK
{
"target": "application",
"redirect": "https://example.com"
}GET /v1/urls/content HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"collection": {
"object": "collection",
"id": "text",
"title": "text",
"description": "text",
"organization": "text",
"parent": "text",
"defaultLevel": "admin",
"urls": {
"location": "https://example.com",
"app": "https://example.com"
},
"permissions": {
"view": true,
"admin": true,
"viewInviteLinks": true,
"create": true
}
}
}GET /v1/urls/embed HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"title": "text",
"site": "text",
"icon": "text",
"type": "link"
}GET /v1/urls/published HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"target": "application",
"redirect": "https://example.com"
}POST /v1/urls/published HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 179
{
"url": "https://example.com",
"redirectOnError": false,
"visitor": {
"jwtToken": "text",
"unsignedClaims": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
}
}
}
}