Resolve a URL of a published content.

post

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

urlstring · uri · max: 2048Required

URL to resolve

redirectOnErrorbooleanOptional

When true redirects the user to the authentication/fallback URL if the access token is invalid

Default: false

Responses

200

OK

application/json

or

or

404

No content found for the URL.

application/json

post/urls/published

HTTPcURLJavaScriptPython

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]"
      }
    }
  }
}

{
  "target": "application",
  "redirect": "https://example.com"
}