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 Builds API

Trigger, query, and manage builds

TeamCity Builds 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 Builds. 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 9 operations across 8 paths, and defines 30 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.

9 operations 8 paths 30 schemas 7 GET1 POST1 PUT

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 Builds 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 9

Across 8 paths, the API surfaces 9 operations — 7 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Builds 9

Trigger, query, and manage builds

GET
/builds
Get All Builds
getAllBuilds 4 params → 200
GET
/builds/{buildLocator}
Get Build
getBuild 2 params → 200404
GET
/builds/{buildLocator}/tags
Get Build Tags
getBuildTags 1 param → 200
PUT
/builds/{buildLocator}/tags
Set Build Tags
setBuildTags 1 param body → 200
GET
/builds/{buildLocator}/artifacts
Get Build Artifacts
getBuildArtifacts 2 params → 200
GET
/builds/{buildLocator}/statistics
Get Build Statistics
getBuildStatistics 2 params → 200
GET
/builds/{buildLocator}/problemOccurrences
Get Build Problem Occurrences
getBuildProblems 2 params → 200
GET
/builds/{buildLocator}/testOccurrences
Get Build Test Occurrences
getBuildTests 5 params → 200
POST
/builds/{buildLocator}/cancel
Cancel Build
cancelBuild 1 param body → 200

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are Build (21 properties), Agent (12 properties), BuildType (12 properties), TestOccurrence (11 properties). Each schema is shown below with its type and property counts.

ProblemOccurrences
object
2 properties
AgentPool
object
6 properties
Changes
object
2 properties
BuildTypes
object
2 properties
BuildType
object
12 properties
Tags
object
2 properties
Roles
object
1 property
Triggers
object
2 properties
TestOccurrences
object
3 properties
Project
object
10 properties
Build
object
21 properties
Steps
object
2 properties
Change
object
9 properties
TestOccurrence
object
11 properties
Files
object
3 properties
FileChanges
object
2 properties
User
object
8 properties
Role
object
3 properties
ProblemOccurrence
object
8 properties
BuildCancelRequest
object
2 properties
Property
object
4 properties
Test
object
3 properties
TriggeredBy
object
4 properties
Projects
object
3 properties
Groups
object
2 properties
Agent
object
12 properties
Agents
object
3 properties
Builds
object
4 properties
Group
object
5 properties
Properties
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

teamcity-builds-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 Changes API
TeamCity Cloud API
TeamCity Investigations API
TeamCity Mutes API
TeamCity Problems API
TeamCity Projects API
TeamCity Server API
Where this information came from

This is an independent, third-party profile of TeamCity Builds 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.