Publish a site to make it publicly accessible

Makes the site publicly accessible at its configured URL by publishing it. If the organization's plan requires an upgrade, the response includes a Stripe checkout session ID instead of the site object. Use unpublish to take the site offline again.

Available in MCP

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

Responses

200

Site published successfully

application/json

or

post/orgs/{organizationId}/sites/{siteId}/publish

POST /v1/orgs/{organizationId}/sites/{siteId}/publish HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Site published successfully

{
  "object": "site",
  "id": "text",
  "type": "basic",
  "appliedType": "basic",
  "title": "text",
  "icon": {
    "icon": {
      "light": "https://example.com",
      "dark": "https://example.com"
    }
  },
  "hostname": "text",
  "basename": "text",
  "proxy": {
    "origin": "text",
    "target": "text"
  },
  "visibility": "public",
  "defaultLevel": "admin",
  "permissions": {
    "view": true,
    "access": true,
    "edit": true,
    "create": true,
    "admin": true,
    "installIntegration": true,
    "viewAdaptiveSchema": true,
    "editAdaptiveSchema": true
  },
  "published": true,
  "siteSpaces": 1,
  "gitSync": {
    "repoName": "text",
    "installationStatus": "unauthenticated",
    "installationProvider": "github",
    "installationId": "text",
    "parentInstallationId": "text",
    "url": "text",
    "operation": {
      "state": "running",
      "direction": "export",
      "startedAt": "2026-01-01T00:00:00.000Z",
      "endedAt": "2026-01-01T00:00:00.000Z",
      "error": "text",
      "errorAction": {
        "label": "text",
        "url": "https://example.com"
      }
    },
    "operationTimeout": 1,
    "updatedAt": "2026-01-01T00:00:00.000Z"
  },
  "createdAt": "2026-01-01T00:00:00.000Z",
  "lastScanAt": "2026-01-01T00:00:00.000Z",
  "adaptiveContent": {
    "enabled": true
  },
  "ads": {
    "status": "pending",
    "submittable": true
  },
  "styleguide": {
    "kind": "space",
    "space": "text"
  },
  "features": [
    {
      "id": "sites-adaptive-content",
      "plan": "basic",
      "frozen": true,
      "customizations": [
        "header-logo"
      ]
    }
  ],
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com",
    "published": "https://example.com",
    "preview": "https://example.com",
    "login": "https://example.com",
    "logout": "https://example.com"
  }
}