TeamCity 2021.1 Help

Get Build Configuration Details

This article shows how to get build configuration details via REST API.

List Build Configurations

To get all build configurations on the server, use:

GET http://<TeamCity Server host>:<port>/app/rest/buildTypes

Server will respond with a BuildTypes entity which contains the BuildType entities found by request.

Get Specific Build Configurations

To locate specific build configurations, use:

GET http://<TeamCity Server host>:<port>/app/rest/buildTypes/{buildConfigurationLocator}

where buildConfigurationLocator is a BuildTypeLocator -typed string used to locate the build configuration.

For example, to find a build configuration with the MyBuildConfigurationID ID use:

GET http://<TeamCity Server host>:<port>/app/rest/buildTypes/id:MyBuildConfigurationID

To locate all build configurations directly under the project with the MyProject ID, use:

GET http://<TeamCity Server host>:<port>/app/rest/buildTypes/project:MyProject

To get all build configurations under the above project and all of its subprojects, use:

GET http://<TeamCity Server host>:<port>/app/rest/buildTypes/affectedProject:MyProject
Last modified: 14 October 2021