TeamCity REST API Reference
 
2023.05
You are viewing the documentation for an earlier version of TeamCity REST API Reference.
  1. Common Use Cases
  2. Manage Build Configurations
  3. Get Build Configuration Details

Get Build Configuration Details

Last modified: 28 August 2023

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
/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
/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
/app/rest/buildTypes/id:MyBuildConfigurationID

To locate all build configurations explicitly owned by a project with the MyProject ID, use:

GET
/app/rest/buildTypes?locator=project:MyProject

The request above does not return build configurations owned by subprojects of the MyProject project. To obtain all configurations, including those owned by child subprojects, use the following request instead:

GET
/app/rest/buildTypes?locator=affectedProject:<ProjectLocator>