Site auth
Manage the authentication needed for publishing your site.
Last updated
Was this helpful?
Manage the authentication needed for publishing your site.
Last updated
Was this helpful?
Was this helpful?
Configure the credentials or tokens required to publish documentation externally. This helps ensure your site is consistently kept up to date.
The unique id of the organization
The unique id of the site
OK
Bad Request
Regenerate the publishing authentication settings for a site. This will re-generate the private key.
The unique id of the organization
The unique id of the site
OK
Bad Request
{
"backend": "custom",
"object": "publishing-auth",
"privateKey": "text",
"fallbackURL": "https://example.com",
"integration": "text"
}{
"backend": "custom",
"object": "publishing-auth",
"privateKey": "text",
"fallbackURL": "https://example.com",
"integration": "text"
}GET /v1/orgs/{organizationId}/sites/{siteId}/publishing/auth HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"backend": "custom",
"object": "publishing-auth",
"privateKey": "text",
"fallbackURL": "https://example.com",
"integration": "text"
}PATCH /v1/orgs/{organizationId}/sites/{siteId}/publishing/auth HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"backend": "custom",
"fallbackURL": "https://example.com"
}POST /v1/orgs/{organizationId}/sites/{siteId}/publishing/auth/regenerate HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"backend": "custom",
"object": "publishing-auth",
"privateKey": "text",
"fallbackURL": "https://example.com",
"integration": "text"
}