Where to Host the Git Repository

When creating an API Repository, you need to choose where to host your Git repository. The first step of the creation wizard, Where Repo Is Hosted, offers two options: APIGit and Any Git Platform.

Option 1: Host on APIGit (Recommended)

Store your API Repository directly on our platform. This is the most efficient option since APIGit features native Git support and provides a GitHub-similar experience, giving you a single platform for both API development and Git-based version control.

Even with this option, you can still copy your APIGit repository to third-party providers by configuring Push Mirrors.

Option 2: Connect to Third-party Git Providers

Connect to GitHub, GitLab, Bitbucket, Azure, AWS, Gitee, or a self-hosted Git server with public access. The repository address must start with https://. In this scenario, APIGit maintains two-way synchronization with your designated third-party Git repository:

• Any updates from your third-party Git repository will automatically synchronize to APIGit
• Any changes made in APIGit will be pushed to your third-party Git repository

Since your third-party repository serves as the single source of truth in this case, some features in APIGit are not available. See Working with a synchronized repository.

How two-way synchronization works

• From the remote to APIGit: APIGit fetches from your remote repository before every write, and on reads once a minimum interval has passed since the last fetch. To fetch right away, use the Sync from remote repository button in the repository toolbar.
• From APIGit to the remote: commits and branch changes made in APIGit are pushed to your remote repository first, and then synchronized back.

Working with a synchronized repository

A synchronized repository differs from one hosted on APIGit:

• There are no Pull Requests or Issues tabs. Manage those on your Git provider.
• Settings has only General, plus Team Collaboration for organization repositories. Branch and tag protection, deploy keys, push mirrors and webhooks are managed on your Git provider.
• The clone dialog shows the address of your remote repository, without the HTTPS/SSH switch or the zip download. To work from the command line, clone from your remote repository and push there.
• When you commit from the GUI, the option to create a new branch for the commit is not offered.

To change the credentials APIGit uses for your remote repository, go to Settings → General → Remote Repository and click update credential. Choose Token or Username and Password.

Deleting a synchronized repository from APIGit does not affect your remote repository.