Install a Git Sync provider on a target
The provider of the Git Sync installation.
Resource targeted by a Git Sync installation.
Git Sync installation was created successfully
Provider-specific setup payload for a Git Sync installation.
Optional directory used when syncing a monorepo subdirectory.
Optional template used when generating commit messages.
Whether previews should be generated from branches outside the configured branch. For space installations belonging to a parent installation, this field is inherited from the parent installation and cannot be set.
Which side should be treated as the source of truth when Git Sync is configured.
Unique identifier of the Git Sync installation.
The ID of the parent Git Sync installation, if any.
Resource targeted by a Git Sync installation.
Identifier of the user who created the installation.
Identifier of the user who connected the Git provider credentials. Only this user can browse repositories or change the repository and branch with them. Null when it is unknown, for credentials connected before it was recorded, until someone reconnects the provider.
Not Found
Conflict
POST /v1/git/installations HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"provider": "github",
"target": {
"type": "space",
"spaceId": "text",
"siteId": "text"
}
}{
"projectDirectory": "text",
"commitMessageTemplate": "text",
"previewExternalBranches": true,
"agentInstructions": [
"agents"
],
"priority": "git",
"provider": "github",
"providerConfiguration": {
"repositoryId": 1,
"branch": "text"
},
"object": "git-sync-installation",
"id": "text",
"parentInstallationId": "text",
"target": {
"type": "space",
"spaceId": "text",
"siteId": "text"
},
"status": "unauthenticated",
"repositoryConnection": {
"object": "git-repository-connection",
"id": "text",
"provider": "github",
"repositoryId": "text",
"repositoryName": "text",
"repositoryUrl": "https://example.com",
"defaultBranch": "text",
"authState": "pending",
"capabilities": {
"pullRequests": true,
"commitStatuses": true
},
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"repositoryRef": {
"object": "git-repository-ref",
"id": "text",
"name": "text",
"type": "branch",
"latestObservedCommitId": "text",
"latestImportedCommitId": "text",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"syncRoot": {
"object": "git-sync-root",
"id": "text",
"installationId": "text",
"target": {
"type": "space",
"spaceId": "text",
"siteId": "text"
},
"defaultMergeAuthorityPolicy": "provider",
"status": "active",
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"createdAt": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"authorizedBy": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"urls": {
"location": "https://example.com"
}
}Last updated
Was this helpful?