Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TeamCity Projects API

Manage TeamCity projects

TeamCity Projects 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 Projects. 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 6 operations across 4 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version 2024.12.1.

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

6 operations 4 paths 9 schemas 1 DELETE4 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
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 Projects 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 6

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

Projects 6

Manage TeamCity projects

GET
/projects
Get All Projects
getAllProjects 2 params → 200401
POST
/projects
Create Project
createProject body → 200400401
GET
/projects/{projectLocator}
Get Project
getProject 2 params → 200404
DELETE
/projects/{projectLocator}
Delete Project
deleteProject 1 param → 204404
GET
/projects/{projectLocator}/parameters
Get Project Parameters
getProjectParameters 2 params → 200
GET
/projects/{projectLocator}/buildTypes
Get Project Build Configurations
getProjectBuildTypes 2 params → 200

Schemas 9

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

BuildTypes
object
2 properties
BuildType
object
12 properties
Triggers
object
2 properties
NewProjectDescription
object
4 properties 1 required
Steps
object
2 properties
Properties
object
3 properties
Project
object
10 properties
Property
object
4 properties
Projects
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

teamcity-projects-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 Server API