VcsRootInstance
An instance of the VCS root. VCS roots are abstract storages of VCS connection settings that cannot be used directly. Build configurations, triggers, build features, and other TeamCity entities use instances of corresponding VCS roots to perform their tasks (checkout sources, post build statuses, and so on). If a root includes parameter references in its settings (for example, {'name':'branch','value':'%main-branch%'}), it spawns a separate instance for each configuration that has a unique value for that parameter. Otherwise, if all root settings are static, it generates one instance that can be attached to any number of build configurations.
Related Help article: VCS Settings
Properties
id
The internal read-only ID of this root instance.
vcs-root-id
The ID of a parent VcsRoot.
vcsRootInternalId
The internal ID of a parent VcsRoot
name
The public name of a parent VcsRoot.
vcsName
The type of a VCS provider to which the parent VcsRoot connects.
modificationCheckInterval
The actual interval (in seconds) for polling VCS for new changes.
commitHookMode
Returns true if the configuration uses post-commit hooks to get new repository changes' notifications; false if pending changes are retrieved via periodic repository polling.
lastVersion
The latest revision of a remote repository branch targeted by this root instance.
lastVersionInternal
This is the internal property and is not intented to be used.
href
The short (without TeamCity server address) link to this root instance.
vcs-root
The parent VCS root of this VCS root instance.
status
Stores results of both current and previous VCS root checkups.
repositoryState
A RepositoryState object that stores the list of available repository branches with their latest revisions.
properties
The list of actual VCS root instance settings, including values resolved from parameter references used in a parent VCS root.
repositoryIdStrings
The list of internally used repository IDs.
projectLocator
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.