TeamCity 2020.2 Help

VcsRootInstanceApi

getAllVcsRootInstances

Get all VCS root instances.

Endpoint

/app/rest/vcs-root-instances

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

VcsRootInstances

requestPendingChangesCheck

Check for the pending changes for all VCS root instances.

Endpoint

/app/rest/vcs-root-instances/checkingForChangesQueue

HTTP method

POST

Produces

  • application/xml
  • application/json

Parameters

Response

VcsRootInstances

triggerCommitHookNotification

Send the commit hook notification.

Endpoint

/app/rest/vcs-root-instances/commitHookNotification

HTTP method

POST

Produces

  • text/plain

Parameters

getVcsRootInstance

Get VCS root instance matching the locator.

Endpoint

/app/rest/vcs-root-instances/{vcsRootInstanceLocator}

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

VcsRootInstance

getFilesList

List all files.

Endpoint

/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/files/latest

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

Files

getZippedFile

Get specific file zipped.

Endpoint

/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/files/latest/archived{path}

HTTP method

GET

Produces

  • */*

Parameters

downloadFile

Download specific file.

Endpoint

/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/files/latest/files{path}

HTTP method

GET

Produces

  • */*

Parameters

getFileMetadata

Get metadata of specific file.

Endpoint

/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/files/latest/metadata{path}

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

file

getFilesListForSubpath

List files under this path.

Endpoint

/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/files/latest/{path}

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

Files

getVcsRootInstanceProperties

Get all properties of the matching VCS root instance.

Endpoint

/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/properties

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

Properties

deleteVcsRootInstanceRepositoryState

Delete the last repository state of the matching VCS root instance.

Endpoint

/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/repositoryState

HTTP method

DELETE

Parameters

getVcsRootInstanceRepositoryState

Get the repository state of the matching VCS root instance.

Endpoint

/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/repositoryState

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

Response

Entries

setVcsRootInstanceRepositoryState

Update the repository state of the matching VCS root instance.

Endpoint

/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/repositoryState

HTTP method

PUT

Consumes

  • application/xml
  • application/json

Produces

  • application/xml
  • application/json

Parameters

Response

Entries

getVcsRootInstanceCreationDate

Get the creation date of the matching VCS root instance.

Endpoint

/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/repositoryState/creationDate

HTTP method

GET

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

deleteVcsRootInstanceField

Remove a field of the matching VCS root instance.

Endpoint

/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/{field}

HTTP method

DELETE

Parameters

getVcsRootInstanceField

Get a field of the matching VCS root instance.

Endpoint

/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/{field}

HTTP method

GET

Produces

  • text/plain

Parameters

Response

string

setVcsRootInstanceField

Get a field of the matching VCS root instance.

Endpoint

/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/{field}

HTTP method

PUT

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

Last modified: 20 February 2021