RESTKDocs

Git Sync

Store your API workspace as plain files in a git repo you own — commit, branch, review, and merge API changes like code, with automatic secret protection.

5 min read

Git sync keeps your API workspace in a git repository you own. Your requests, environments, folders, and collection runners are versioned there, so you can commit, branch, review, and merge changes to your API workspace with the same workflow you already use for code.

RESTK handles the git work for you from inside the app, so you do not need a separate git client to get started.

Secrets are never committed

Any value you mark as a secret is kept out of your commits. Teammates can see that the workspace expects that secret — so they know what to provide — but never your actual value.

Quick Start

Turn On Git Mode

When you create a workspace, or from an existing workspace's settings, choose Git as the sync mode, then link a folder in a git repository you own — or clone your team's existing repository.

Work Normally

Build and organize your requests, environments, and runners as usual. RESTK keeps the repository in step with your changes as you work.

Review and Commit

Open the Source Control panel, review what changed, write a message, and commit.

Push and Pull

Push to share your work, and pull to bring in your teammates' changes. RESTK merges their changes with yours automatically.

Committing Changes

The Source Control panel is where you manage everything git-related without leaving RESTK.

Review What Changed

The panel lists every change since your last commit — new requests, edits, renames, moves, and deletions — so you can see exactly what you are about to record.

Write a Message

Add a commit message describing the change, just as you would for code.

Commit

Commit to record the change in your repository's history. You can commit with no network connection and push later.

Push When Ready

Push to publish your commits to the shared repository so your team can pull them.

Use your own tools too

Because your workspace lives in a repository you own, your usual git tools work alongside RESTK. You can review history, branch, and manage remotes however you normally do.

Reviewing API Changes

Git mode gives your API workspace the same review workflow as your code:

  • Branch to build a new set of requests without affecting anyone else's work.
  • Open a pull request so a change to a shared endpoint gets reviewed before it lands.
  • See the history of who changed what, and when.
  • Roll back by reverting a commit if a change needs to be undone.

Pulling and Merging

When you pull your teammates' changes, RESTK merges them with your own work rather than overwriting either side.

Pull Changes

Pull to bring in the latest work from your team.

Independent Changes Merge Automatically

If you and a teammate changed different things — you edited a request's URL, they edited its headers — both changes are kept, with nothing for you to resolve.

Same-Change Conflicts Open the Visual Resolver

When two people changed the same thing, RESTK stops and shows your version and their version side by side, so you resolve by choosing a side instead of untangling raw conflict markers. If you want finer control, you can still drop into a manual edit for any conflict.

Confirm and Continue

Once you have made your choices, RESTK completes the merge and your workspace is up to date.

Renames and moves are preserved

Renaming a request or folder is kept as a rename, not a delete-and-re-add, so its history survives. Moving a request between folders keeps the request intact. These are the cases that quietly lose work in tools that treat a workspace as plain text, and RESTK is built to handle them.

Secret Protection

Git sync is designed so you can put a workspace in a repository without exposing your credentials.

Mark a Value as Secret

Mark any sensitive value — a token, an API key, a password — as a secret in its environment or request.

The Value Stays Out of Your Commits

When RESTK records your workspace, secret values are left out. Your teammates can see that the workspace expects a given secret, so they know what to fill in, but they never see your value.

A Secret Scan Runs Before You Share

Before every commit and push, RESTK scans for exposed API keys and tokens — the kind that get pasted in by accident. If a sensitive value is about to enter your repository, RESTK warns you before it does.

Marked secrets never leave your machine

A value you mark as secret is never committed to git and never synced — in any mode. It stays on your device.

Working Offline

Git mode is offline-first. You can commit locally with no network connection and push when you are back online. Everything keeps working whether or not a remote is reachable.

When to Use Git Sync

Git sync is the right mode when:

  • Your API workspace should live alongside the code it describes.
  • You want changes to shared endpoints reviewed before they land.
  • You need a full history of who changed what, and the ability to roll back.
  • You want your workspace in infrastructure you own.

If you want changes to appear instantly across devices without committing, see Sync & Collaboration for cloud sync. If you want nothing to sync anywhere, see Workspace Modes for local mode.

Related