GitHub API reference

Connect a GitHub repository to a bucket: its files become a copy of one branch, and each push updates them.

Requests go to https://api.revdoku.com. Every path starts with /v1, for example https://api.revdoku.com/v1/buckets. Send Authorization: Bearer $REVDOKU_API_KEY from your server. Tables use JSON names; where TypeScript differs, a field shows json_name / typescriptName. Python uses the JSON names.

All operations · API guide · Errors · OpenAPI

• List connected GitHub accounts: GET /v1/account/github/installations
• List the repositories of a GitHub account: GET /v1/account/github/installations/{installation_id}/repositories
• Read the GitHub repository of a bucket: GET /v1/buckets/{bucket_id}/github
• Connect a GitHub repository: POST /v1/buckets/{bucket_id}/github
• Change GitHub sync settings: PATCH /v1/buckets/{bucket_id}/github
• Disconnect the GitHub repository: DELETE /v1/buckets/{bucket_id}/github
• Sync the GitHub repository now: POST /v1/buckets/{bucket_id}/github/sync
• List the branches that can get a preview: GET /v1/buckets/{bucket_id}/github/branches
• Get the links to add a GitHub account: GET /v1/buckets/{bucket_id}/github/setup_link

List connected GitHub accounts

GET /v1/account/github/installations

Returns the GitHub accounts and organizations where a person installed the Revdoku GitHub App for this account. Each one reads the repositories that its owner chose on GitHub. Needs an account owner or administrator key with admin access to all buckets. To add a GitHub account, get the links with getGithubSetupLink.

Parameters

Examples

TypeScript

import { Revdoku } from 'revdoku';

const client = new Revdoku();
const { data } = await client.api.listGithubInstallations();
console.log(data);

Python

from revdoku import Revdoku

client = Revdoku()
response = client.api.list_github_installations()
print(response.data)

cURL

curl "https://api.revdoku.com/v1/account/github/installations" \
  -H "Authorization: Bearer $REVDOKU_API_KEY"

Response 200

{
  "success": true,
  "data": {
    "installations": [
      {
        "installation_id": 51234567,
        "github_account_login": "acme",
        "github_account_type": "Organization",
        "settings_url": "https://github.com/organizations/acme/settings/installations/51234567",
        "repository_selection": "selected"
      }
    ],
    "pagination": {"limit": 50, "has_more": false, "next_cursor": null}
  }
}

Errors

Guide: GitHub repositories

List the repositories of a GitHub account

GET /v1/account/github/installations/{installation_id}/repositories

Returns the repositories that one connected GitHub account lets Revdoku read, A-Z by full name. A repository that is not listed needs access on GitHub: give the account’s settings_url to its owner. Needs an account owner or administrator key with admin access to all buckets.

Parameters

Examples

TypeScript

import { Revdoku } from 'revdoku';

const client = new Revdoku();
const { data } = await client.api.listGithubRepositories({ installationId: 1 });
console.log(data);

Python

from revdoku import Revdoku

client = Revdoku()
response = client.api.list_github_repositories(1)
print(response.data)

cURL

curl "https://api.revdoku.com/v1/account/github/installations/1/repositories" \
  -H "Authorization: Bearer $REVDOKU_API_KEY"

Response 200

Errors

Guide: GitHub repositories

Read the GitHub repository of a bucket

GET /v1/buckets/{bucket_id}/github

Returns the bucket’s GitHub repository and its sync state. github is null when the bucket never had one. After connectGithubRepository, read it until last_synced_at is set (the first copy is done) or sync_state is error.

Parameters

Examples

TypeScript

import { Revdoku } from 'revdoku';

const client = new Revdoku();
const { data } = await client.api.getGithubSync({ bucketId: 'bkt_example' });
console.log(data);

Python

from revdoku import Revdoku

client = Revdoku()
response = client.api.get_github_sync("bkt_example")
print(response.data)

cURL

curl "https://api.revdoku.com/v1/buckets/bkt_example/github" \
  -H "Authorization: Bearer $REVDOKU_API_KEY"

Response 200

{
  "success": true,
  "data": {
    "github": {
      "id": "bgh_8xQ2kL4mN7pR",
      "bucket_id": "bkt_5Gh3Lm9Qx2Tz",
      "installation_id": 51234567,
      "repo_owner": "acme",
      "repo_name": "docs",
      "repo_full_name": "acme/docs",
      "repository_url": "https://github.com/acme/docs",
      "branch": "main",
      "repo_path": null,
      "sync_state": "idle",
      "last_error": null,
      "next_retry_at": null,
      "last_synced_at": "2026-11-09T10:15:00Z",
      "last_synced_commit_sha": "4f1c2e9a7b3d5f6081a2c3d4e5f60718293a4b5c",
      "last_synced_commit_message": "Add the quickstart page",
      "auto_publish": true,
      "push_revdoku_edits": false,
      "auto_commit": false,
      "pending_count": 0,
      "pending_changes": [],
      "pull_request": null,
      "skipped_files": [],
      "auto_publish_error": null,
      "dashboard_url": "https://app.revdoku.com/buckets/view?account_id=acct_3Fh8Qm2Lx9Tw&id=bkt_5Gh3Lm9Qx2Tz&site=github&view=site",
      "created_at": "2026-11-09T10:14:20Z",
      "updated_at": "2026-11-09T10:15:00Z"
    }
  }
}

Errors

Guide: GitHub repositories

Connect a GitHub repository

POST /v1/buckets/{bucket_id}/github

Makes the bucket’s files a copy of one branch of a repository, or of one folder of it. The first sync copies the files, and each later push to the branch updates them. The bucket must have no files of its own; its email and agent folders may stay. GitHub stays the source: Revdoku never copies a bucket into a repository. Needs an account owner or administrator key with admin access to all buckets. A connected GitHub account must read the repository: 403 GITHUB_APP_NOT_INSTALLED gives the links for the person in error.details.

Parameters

Request body: TypeScript connectGithubRepositoryRequest: ConnectGithubRepositoryRequest, Python connect_github_repository_request=ConnectGithubRepositoryRequest(...).

Examples

TypeScript

import { Revdoku } from 'revdoku';

const client = new Revdoku();
const { data } = await client.api.connectGithubRepository({
  bucketId: 'bkt_example',
  connectGithubRepositoryRequest: { github: { repoOwner: 'example', repoName: 'example' } },
});
console.log(data);

Python

from revdoku import Revdoku, ConnectGithubRepositoryRequest, GithubConnect

client = Revdoku()
response = client.api.connect_github_repository(
    "bkt_example",
    ConnectGithubRepositoryRequest(
        github=GithubConnect(repo_owner="example", repo_name="example"),
    ),
)
print(response.data)

cURL

curl -X POST "https://api.revdoku.com/v1/buckets/bkt_example/github" \
  -H "Authorization: Bearer $REVDOKU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"github": {"repo_owner": "example", "repo_name": "example"}}'

Response 201

Errors

Error codes named above: GITHUB_APP_NOT_INSTALLED.

Guide: GitHub repositories

Change GitHub sync settings

PATCH /v1/buckets/{bucket_id}/github

Sets auto_publish and the mode of edits made in Revdoku: push_revdoku_edits false makes the files a read-only copy, auto_commit true commits edits to the branch at each sync, and auto_commit false keeps them in pending_changes until a person publishes them in the dashboard. Needs an account owner or administrator key with admin access to all buckets.

Parameters

Request body: TypeScript updateGithubSyncRequest: UpdateGithubSyncRequest, Python update_github_sync_request=UpdateGithubSyncRequest(...).

Examples

TypeScript

import { Revdoku } from 'revdoku';

const client = new Revdoku();
const { data } = await client.api.updateGithubSync({
  bucketId: 'bkt_example',
  updateGithubSyncRequest: { github: {} },
});
console.log(data);

Python

from revdoku import Revdoku, GithubSyncSettings, UpdateGithubSyncRequest

client = Revdoku()
response = client.api.update_github_sync(
    "bkt_example",
    UpdateGithubSyncRequest(github=GithubSyncSettings()),
)
print(response.data)

cURL

curl -X PATCH "https://api.revdoku.com/v1/buckets/bkt_example/github" \
  -H "Authorization: Bearer $REVDOKU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"github": {}}'

Response 200

Errors

Guide: GitHub repositories

Disconnect the GitHub repository

DELETE /v1/buckets/{bucket_id}/github

Stops the sync. The bucket keeps its files and its site. A later read shows the link with sync_state disconnected; connect the same repository again to continue its copy. Needs an account owner or administrator key with admin access to all buckets.

Parameters

Examples

TypeScript

import { Revdoku } from 'revdoku';

const client = new Revdoku();
const { data } = await client.api.disconnectGithubRepository({
  bucketId: 'bkt_example',
});
console.log(data);

Python

from revdoku import Revdoku

client = Revdoku()
response = client.api.disconnect_github_repository("bkt_example")
print(response.data)

cURL

curl -X DELETE "https://api.revdoku.com/v1/buckets/bkt_example/github" \
  -H "Authorization: Bearer $REVDOKU_API_KEY"

Response 200

Errors

Guide: GitHub repositories

Sync the GitHub repository now

POST /v1/buckets/{bucket_id}/github/sync

Copies new commits of the branch now and tries a failed sync again. Pushes sync without this call; use it after an error, or after a person changed access on GitHub. enqueued is false when a sync already runs. Needs an account owner or administrator key with admin access to all buckets.

Parameters

Request body (optional): TypeScript actionRequest: ActionRequest, Python action_request=ActionRequest(...).

Examples

TypeScript

import { Revdoku } from 'revdoku';

const client = new Revdoku();
const { data } = await client.api.syncGithubRepository({
  bucketId: 'bkt_example',
});
console.log(data);

Python

from revdoku import Revdoku

client = Revdoku()
response = client.api.sync_github_repository("bkt_example")
print(response.data)

cURL

curl -X POST "https://api.revdoku.com/v1/buckets/bkt_example/github/sync" \
  -H "Authorization: Bearer $REVDOKU_API_KEY"

Response 202

Errors

Guide: GitHub repositories

List the branches that can get a preview

GET /v1/buckets/{bucket_id}/github/branches

Returns the branches of the bucket’s GitHub repository, without the linked branch (the site shows it), A-Z. Pass one as branch to previewBucket. Requires bucket publish permission. 404 GITHUB_SYNC_NOT_CONNECTED without a repository.

Parameters

Examples

TypeScript

import { Revdoku } from 'revdoku';

const client = new Revdoku();
const { data } = await client.api.listGithubBranches({
  bucketId: 'bkt_example',
});
console.log(data);

Python

from revdoku import Revdoku

client = Revdoku()
response = client.api.list_github_branches("bkt_example")
print(response.data)

cURL

curl "https://api.revdoku.com/v1/buckets/bkt_example/github/branches" \
  -H "Authorization: Bearer $REVDOKU_API_KEY"

Response 200

{"success": true, "data": {"branches": ["next", "pricing-page"]}}

Errors

Error codes named above: GITHUB_SYNC_NOT_CONNECTED.

Guide: GitHub repositories

Get the links to add a GitHub account

GET /v1/buckets/{bucket_id}/github/setup_link

Returns the links that a person opens to add a GitHub account or organization to this Revdoku account. Only the person who owns this key or AI connection can finish the step, signed in to Revdoku, within 30 minutes. Give install_url to install the Revdoku GitHub App; on GitHub the person chooses the account and the repositories. Give authorization_url when the App is already installed on that GitHub account; the person then selects Connect on the bucket’s GitHub page. Then list the connected GitHub accounts until the new one shows. Needs an account owner or administrator key with admin access to all buckets.

Parameters

Examples

TypeScript

import { Revdoku } from 'revdoku';

const client = new Revdoku();
const { data } = await client.api.getGithubSetupLink({
  bucketId: 'bkt_example',
});
console.log(data);

Python

from revdoku import Revdoku

client = Revdoku()
response = client.api.get_github_setup_link("bkt_example")
print(response.data)

cURL

curl "https://api.revdoku.com/v1/buckets/bkt_example/github/setup_link" \
  -H "Authorization: Bearer $REVDOKU_API_KEY"

Response 200

Errors

Guide: GitHub repositories