Setting VCS checkout mode via the API

Created May 02, 2023 07:30

I am looking for clarification on the API payload syntax to set the "VCS checkout mode" of a build configuration to "Always checkout files on server".

I suspect it is this API endpoint but I cant find the syntax for this option anywhere:

Edit Build Configuration Settings | TeamCity REST API Reference Documentation (jetbrains.com)

Any help would be appreciated.

1 comment

Fedor Rumyantsev

Created May 02, 2023 09:05

Hello Steven,

Unfortunately, there is no specific field for that - however, we have a feature request on the matter. Please consider voting or commenting on it to keep track on the issue progress.

For now, you may use the following request to get this setting value for all build configurations:

/app/rest/buildTypes?fields=buildType(id,name,webUrl,settings($locator(name:checkoutMode),property(value)))

or for a specific configuration:

/app/rest/buildTypes/id:<build configuration ID>?fields=id,name,webUrl,settings($locator(name:checkoutMode),property(value))

If build configuration uses a non-default setting (e.g. not Prefer to checkout files on agent side), you will see the following response:

<buildType id="Support_Test" name="Test" webUrl="http://localhost:8111/viewType.html?buildTypeId=Support_Test">
    <script/>
    <settings>
        <property value="ON_SERVER"/>
    </settings>
</buildType>

Otherwise, settings block will be empty.

Please let me know if this helps.

Please sign in to leave a comment.