TeamCity REST API Reference 2025.07 Help

VcsRootEntry

A VCS root attached to a configuration coupled with this configuration's checkout rules.

Properties

id

The ID of the attached VCS root.

inherited

This is the internal property and is not intented to be used.

vcs-root

The attached VCS root.

checkout-rules

Checkout rules that allow configurations to partially checkout remote repositories.

Schema

Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.

A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.

<vcs-root-entry checkout-rules="-:src/help\n+:src=>production/sources\n+:src/samples=>./samples" id="MyProject_CustomRootFromConfig" inherited="false"> <vcs-root href="/app/rest/vcs-roots/id:Builders_MainGitRoot" id="Builders_MainGitRoot" internalId="599" locator="id:Builders_MainGitRoot" modificationCheckInterval="123" name="MainGitRoot" projectLocator="Obsolete" uuid="02308f8f-60f8-4b28-a964-7911ef0159eb" vcsName="jetbrains.git"> <project>[[[project...|project.html]]]</project> <properties>[[[properties...|properties.html]]]</properties> <vcsRootInstances>[[[vcs-root-instances...|vcsrootinstances.html]]]</vcsRootInstances> <repositoryIdStrings>[[[items...|items.html]]]</repositoryIdStrings> </vcs-root> </vcs-root-entry>
{ "inherited" : false, "vcs-root" : { "vcsRootInstances" : "[[[vcs-root-instances...|vcsrootinstances.html]]]", "project" : "[[[project...|project.html]]]", "projectLocator" : "Obsolete", "uuid" : "02308f8f-60f8-4b28-a964-7911ef0159eb", "modificationCheckInterval" : 2, "internalId" : "599", "name" : "MainGitRoot", "vcsName" : "jetbrains.git", "id" : "Builders_MainGitRoot", "href" : "/app/rest/vcs-roots/id:Builders_MainGitRoot", "locator" : "id:Builders_MainGitRoot", "properties" : "[[[properties...|properties.html]]]", "repositoryIdStrings" : "[[[items...|items.html]]]" }, "checkout-rules" : "-:src/help\\n+:src=>production/sources\\n+:src/samples=>./samples", "id" : "MyProject_CustomRootFromConfig" }
Last modified: 15 July 2025