TeamCity REST API Reference 2022.10 Help

VcsRootApi

getAllVcsRoots

Get all VCS roots.

Endpoint

/app/rest/vcs-roots

Produces

  • application/xml

  • application/json

Parameters

Response

VcsRoots

addVcsRoot

Add a new VCS root.

Endpoint

/app/rest/vcs-roots

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

VcsRoot

deleteVcsRoot

Remove VCS root matching the locator.

Endpoint

/app/rest/vcs-roots/{vcsRootLocator}

Parameters

getRootEndpoints

Get root endpoints.

Endpoint

/app/rest/vcs-roots/{vcsRootLocator}

Produces

  • application/xml

  • application/json

Parameters

Response

VcsRoot

getVcsRootInstances

Get all VCS root instances of the matching VCS root.

Endpoint

/app/rest/vcs-roots/{vcsRootLocator}/instances

Produces

  • application/xml

  • application/json

Parameters

Response

VcsRootInstances

deleteAllVcsRootProperties

Delete all properties of the matching VCS root.

Endpoint

/app/rest/vcs-roots/{vcsRootLocator}/properties

Parameters

getAllVcsRootProperties

Get all properties of the matching VCS root.

Endpoint

/app/rest/vcs-roots/{vcsRootLocator}/properties

Produces

  • application/xml

  • application/json

Parameters

Response

Properties

setVcsRootProperties

Update all properties of the matching VCS root.

Endpoint

/app/rest/vcs-roots/{vcsRootLocator}/properties

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Properties

deleteVcsRootProperty

Delete a property of the matching VCS root.

Endpoint

/app/rest/vcs-roots/{vcsRootLocator}/properties/{name}

Parameters

getVcsRootProperty

Get a property on the matching VCS root.

Endpoint

/app/rest/vcs-roots/{vcsRootLocator}/properties/{name}

Produces

  • text/plain

Parameters

Response

string

setVcsRootProperty

Update a property of the matching VCS root.

Endpoint

/app/rest/vcs-roots/{vcsRootLocator}/properties/{name}

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

getVcsRootSettingsFile

Get the settings file of the matching VCS root.

Endpoint

/app/rest/vcs-roots/{vcsRootLocator}/settingsFile

Produces

  • text/plain

Parameters

Response

string

getVcsRootField

Get a field of the matching VCS root.

Endpoint

/app/rest/vcs-roots/{vcsRootLocator}/{field}

Produces

  • text/plain

Parameters

Response

string

setVcsRootField

Update a field of the matching VCS root.

Endpoint

/app/rest/vcs-roots/{vcsRootLocator}/{field}

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

Last modified: 26 October 2022