You are viewing the documentation of TeamCity 10.x and 2017.x, which is not the most recently released version of TeamCity.
View this page in the latest documentation or refer to the listing to choose the documentation corresponding to your TeamCity version.


Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


Using a locator in build-related requests, you can filter the builds to be returned in the build-related requests. It is referred to as "build locator" in the scope of REST API.By default excluded are: not-finished, canceled,

There is "default" filter which returns only "normal" builds. To return all builds, use "defaultFilter:false" dimension.
The default filter is that only finished builds which are not canceled, not failed-to-start, not personal, and on non- default branch (in branched build configurations) are included. If only not finished builds . To return all builds, use "defaultFilter:false" dimensionare requested (e.g. via "running:true"), "agent" or "user" dimensions are present - default filtering is not applied.

Examples of supported build locators: