Share via


Properties - Get Build Properties

Gets properties for a build.

GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/properties?api-version=7.1
GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/properties?filter={filter}&api-version=7.1

URI Parameters

Name In Required Type Description
buildId
path True

integer (int32)

The ID of the build.

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.

filter
query

string (array (string))

A comma-delimited list of properties. If specified, filters to these specific properties.

Responses

Name Type Description
200 OK

PropertiesCollection

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

PropertiesCollection

The class represents a property bag as a collection of key-value pairs. Values of all primitive types (any type with a TypeCode != TypeCode.Object) except for DBNull are accepted. Values of type Byte[], Int32, Double, DateType and String preserve their type, other primitives are retuned as a String. Byte[] expected as base64 encoded string.

Name Type Description
count

integer (int32)

The count of properties in the collection.

item

object

keys

string[]

The set of keys in the collection.

values

string[]

The set of values in the collection.