Release Management

TFS 2017 | TFS 2015 | TFS 2013


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

api-version = 3.0-preview.1

Using on-premises: An earlier, and slightly different, version of this Release Management API is available in Team Foundation Server 2015 Update 2. To use, you must specify an API version of 2.2-preview.1.

New release references a release definition to deploy an application comprising of one/more artifacts. A release process goes through a set of approval requests.

Common tasks

Create a release definition

  1. Add one or more environments to release definition.
  2. Add tasks to each environment.
  3. Add approvals or make them automated, for each environment.
  4. Save release definition

Start a release

  1. Get the ID of the release definition that you want to use.
  2. Create a release.
  3. Get the ID of the release from the response so you can use it later.
  4. If required, abandon a release.

Get a release details

  1. Get a list of releases and find the ID of the release you're interested in.
  2. Get the details about the release.
  3. Get the approvals required for the release.

Accept/Reject approvals

For each environment where the application is being deployed, you can have pre-deployment or post-deployment approvals. If you are one of the approvers, you will get an approval request which you can accept or reject based on some criteria.