How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TeamCity VCS Roots API

Manage version control system roots

TeamCity VCS Roots API is one of 17 APIs that TeamCity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include VCS Roots. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a JSON-LD context, and 1 JSON Schema.

This API exposes 4 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 2024.12.1.

Requests are made against a single base URL, https://{server}/app/rest.

4 operations 2 paths 10 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2024.12.1
Base URL
https://teamcity.example.com/app/rest
Authentication
HTTP Bearer, HTTP Basic
Contact
Resource Areas
1

Authentication & Security 2

TeamCity VCS Roots API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication using access tokens
  • basicAuth — HTTP Basic authentication with username and password

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

VCS Roots 4

Manage version control system roots

GET
/vcs-roots
Get All VCS Roots
getAllVcsRoots 2 params → 200
POST
/vcs-roots
Create VCS Root
createVcsRoot body → 200
GET
/vcs-roots/{vcsRootLocator}
Get VCS Root
getVcsRoot 2 params → 200
DELETE
/vcs-roots/{vcsRootLocator}
Delete VCS Root
deleteVcsRoot 1 param → 204

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are BuildType (12 properties), Project (10 properties), VcsRoot (8 properties), Property (4 properties). Each schema is shown below with its type and property counts.

Steps
object
2 properties
Property
object
4 properties
VcsRoots
object
3 properties
Projects
object
3 properties
Properties
object
3 properties
BuildTypes
object
2 properties
VcsRoot
object
8 properties
BuildType
object
12 properties
Triggers
object
2 properties
Project
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

teamcity-vcs-roots-api-openapi.yml Raw ↑

Other APIs TeamCity publishes across the network.

TeamCity Agent Pools API
TeamCity Agents API
TeamCity Audit API
TeamCity Build Configurations API
TeamCity Build Queue API
TeamCity Builds API
TeamCity Changes API
TeamCity Cloud API
TeamCity Investigations API
TeamCity Mutes API
TeamCity Problems API
TeamCity Projects API
Where this information came from

This is an independent, third-party profile of TeamCity VCS Roots API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.