Configure Git credentials for Git Sync in Insomnia

Uses: Insomnia
TL;DR

Add your Git credentials in Preferences > Credentials, select a repository and branch, and confirm the author name and email used for commits.

Prerequisites

Download and install Insomnia.

Ensure that you have access to the Git repository and required permissions to both push and pull changes.

Insomnia Git Sync lets you store and version Insomnia project data in an external Git repository. To push and pull changes, Insomnia requires credentials that authenticate with your Git provider. For example, GitHub, GitLab, or Bitbucket.

You can configure Git credentials:

  • In Insomnia Preferences
  • During Git Sync project setup

Add credentials in Preferences

Adding credentials in Preferences lets you reuse them across projects.

  1. In Insomnia, click Preferences.
  2. Click Credentials.
  3. Under Git Credentials, click Add Credential.
  4. Choose one of the following:
    • GitHub: Complete the OAuth flow.
    • GitLab: Complete the OAuth flow.
    • Access Token: Enter the required fields, such as base URL and access token.
  5. Click Save Credential.

Insomnia stores the credential and makes it available when creating or cloning Git Sync projects.

Validation

To confirm that you’ve successfully configured your git credentials:

  1. In the Insomnia application, in the PROJECTS panel, select the name of your branch.
  2. Click Repository Settings.
  3. Verify that your Git profile is present.

FAQs

Insomnia uses the authentication provider that you selected during Git Sync setup. It also reads credentials from your local Git configuration.

Yes. Insomnia can use credentials configured in your local Git environment for Git operations.

If authentication fails, verify your local Git configuration and confirm that you have access to the repository.

Repository visibility depends on how you authenticate with GitHub.

If you use the GitHub App integration, the app must be granted access to the required private repositories in GitHub. To verify your configuration, navigate to your GitHub Installations.

If you use a Personal Access Token (PAT), use a fine-grained token and ensure that it includes access to the required private repositories.

Classic tokens may not include repository access depending on how they were configured.

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!