Publishing

You can publish a space using the update endpoint documented here.

Authentication

GET publishing authentication information

Get the publishing authentication configuration for a space.

GEThttps://api.gitbook.com/v1/spaces/{spaceId}/publishing/auth

Authorization

user

Path parameters

spaceId*string

The unique id of the space

Response

200400default

OK

Body

application/json

object*enum

Type of Object, always equals to "publishing-auth"

publishing-auth

id*string

Unique identifier for the content.

privateKey*string

Private key used to sign JWT tokens.

fallbackURLstring (uri)

URL to redirect to when the visitor auth secret is invalid.

Request

JavaScriptCurl

const response = await fetch('https://api.gitbook.com/v1/spaces/{spaceId}/publishing/auth', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "object": "publishing-auth",
  "id": "text",
  "privateKey": "text",
  "fallbackURL": "https://example.com"
}

Update the publishing authentication configuration for a space.

POSThttps://api.gitbook.com/v1/spaces/{spaceId}/publishing/auth

Authorization

user

Path parameters

spaceId*string

The unique id of the space

Body

application/json

fallbackURLstring (uri)

A fallback URL that will be used if authentication fails.

Response

200400default

OK

Body

application/json

object*enum

Type of Object, always equals to "publishing-auth"

publishing-auth

id*string

Unique identifier for the content.

privateKey*string

Private key used to sign JWT tokens.

fallbackURLstring (uri)

URL to redirect to when the visitor auth secret is invalid.

Request

JavaScriptCurl

const response = await fetch('https://api.gitbook.com/v1/spaces/{spaceId}/publishing/auth', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "object": "publishing-auth",
  "id": "text",
  "privateKey": "text",
  "fallbackURL": "https://example.com"
}