Yaml - Get

Service:

Build

API Version:

7.1

Converts a definition to YAML, optionally at a specific revision.

GET https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}/yaml?api-version=7.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}/yaml?revision={revision}&minMetricsTime={minMetricsTime}&propertyFilters={propertyFilters}&includeLatestBuilds={includeLatestBuilds}&api-version=7.1

URI Parameters

Name	In	Required	Type	Description
definitionId	path	True	integer (int32)	The ID of the definition.
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '7.1' to use this version of the api.
includeLatestBuilds	query		boolean
minMetricsTime	query		string (date-time)	If specified, indicates the date from which metrics should be included.
propertyFilters	query		string (array (string))	A comma-delimited list of properties to include in the results.
revision	query		integer (int32)	The revision number to retrieve. If this is not specified, the latest version will be returned.

Responses

Name	Type	Description
200 OK	YamlBuild	successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Description
vso.build	Grants the ability to access build artifacts, including build results, definitions, and requests, and the ability to receive notifications about build events via service hooks.

Definitions

YamlBuild

Object

Represents a yaml build.

Name	Type	Description
yaml	string	The yaml used to define the build