VcsRootApi

getAllVcsRoots

Get all VCS roots.


Endpoint	/app/rest/vcs-roots
Produces	`application/xml` `application/json`
Parameters	`locator: string<VcsRootLocator>` `fields: string`
Response	`VcsRoots`

Add a new VCS root.


Endpoint	/app/rest/vcs-roots
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`body: VcsRoot` `fields: string`
Response	`VcsRoot`

Remove VCS root matching the locator.


Endpoint	/app/rest/vcs-roots/{vcsRootLocator}
Parameters	`vcsRootLocator: string<VcsRootLocator>`

Get root endpoints.


Endpoint	/app/rest/vcs-roots/{vcsRootLocator}
Produces	`application/xml` `application/json`
Parameters	`vcsRootLocator: string<VcsRootLocator>` `fields: string`
Response	`VcsRoot`

Get all VCS root instances of the matching VCS root.


Endpoint	/app/rest/vcs-roots/{vcsRootLocator}/instances
Produces	`application/xml` `application/json`
Parameters	`vcsRootLocator: string<VcsRootLocator>` `fields: string`
Response	`VcsRootInstances`

Delete all properties of the matching VCS root.


Endpoint	/app/rest/vcs-roots/{vcsRootLocator}/properties
Parameters	`vcsRootLocator: string<VcsRootLocator>`

Get all properties of the matching VCS root.


Endpoint	/app/rest/vcs-roots/{vcsRootLocator}/properties
Produces	`application/xml` `application/json`
Parameters	`vcsRootLocator: string<VcsRootLocator>` `fields: string`
Response	`Properties`

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	`vcsRootLocator: string<VcsRootLocator>` `body: Properties` `fields: string`
Response	`Properties`

Delete a property of the matching VCS root.


Endpoint	/app/rest/vcs-roots/{vcsRootLocator}/properties/{name}
Parameters	`vcsRootLocator: string<VcsRootLocator>` `name: string`

Get a property on the matching VCS root.


Endpoint	/app/rest/vcs-roots/{vcsRootLocator}/properties/{name}
Produces	`text/plain`
Parameters	`vcsRootLocator: string<VcsRootLocator>` `name: string`
Response	`string`

Update a property of the matching VCS root.


Endpoint	/app/rest/vcs-roots/{vcsRootLocator}/properties/{name}
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`vcsRootLocator: string<VcsRootLocator>` `name: string` `body: string`
Response	`string`

Get the settings file of the matching VCS root.


Endpoint	/app/rest/vcs-roots/{vcsRootLocator}/settingsFile
Produces	`text/plain`
Parameters	`vcsRootLocator: string<VcsRootLocator>`
Response	`string`

Get a field of the matching VCS root.


Endpoint	/app/rest/vcs-roots/{vcsRootLocator}/{field}
Produces	`text/plain`
Parameters	`vcsRootLocator: string<VcsRootLocator>` `field: string`
Response	`string`

Update a field of the matching VCS root.


Endpoint	/app/rest/vcs-roots/{vcsRootLocator}/{field}
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`vcsRootLocator: string<VcsRootLocator>` `field: string` `body: string`
Response	`string`

Last modified: 30 March 2022