Git API

TFS 2017 | TFS 2015 | TFS 2013

Note

Looking for REST APIS that support TFS 2018 or later versions? See the Azure DevOps REST API Reference.

api-version = 1.0

Use these APIs to work with Git repositories in VSTS/TFS. Repositories contain objects representing core Git concepts:

• blobs (files)
• trees (folders)
• commits
• refs (branches, lightweight tags)

and other resources that represent the history of those items or act on their state.

There are code samples available for this area.

Note

Repositories have both a name and an identifier. Identifiers are globally unique, but several projects may contain a repository of the same name. You don't need to include the project if you specify a repository by ID. However, if you specify a repository by name, you must also specify the project (by name or ID).

Common tasks

Areas	Common Tasks
Git Repositories	Get a list of repositories in a project. Add a repository to a project. Delete a repository from a project.
Pull Requests	Complete pull requests Get a list of pull requests Create a pull request Update a pull request
Commits	Get the top commits, or the commits in a date range. Get each commit with the changes in that commit. You can also get the differences between the committed version and the previous version.
Refs (branches and tags)	Get all branches. Create, update, or delete a branch.
Pushes	Get a list of pushes. Get each push with references to the commits. Create a branch (Create a push/initial commit)
Items (Files)	Download a single source file by getting the item representing that file. Download a zip file containing a folder and its contents by getting the item for that folder. Get the metadata for the most recent version of each file or folder by getting the items recursively. Get different versions of the items, too.

All Git API areas

In case you're looking for something not found in the Common tasks section above, below is a list of all areas of the Git API.

• Annotated tags
• Blobs
• Commits
• Diffs
• Import Requests
• Items
• Pull Request Overview
• Pull Request Operations
• Pull Request Comments
• Pull Request Iterations
• Pull Request Reviewers
• Pull Request Work Items
• Pushes
• Refs
• Repositories
• Stats
• Trees

Note

For more information on Git, see Use Git with Visual Studio and Team Foundation Server.