TeamCity
 
You are viewing the documentation for an earlier version of TeamCity.

REST API

Last modified: 11 November 2020

TeamCity provides a REST API for integrating external applications and creating script interactions with the TeamCity server.

REST API is an open-source plugin bundled since TeamCity 5.0.

TeamCity's REST API allows accessing resources (entities) via URL paths. To use the REST API, an external application makes an HTTP request to the TeamCity server and parses the response.

This page describes principles of the REST API authentication, the structure of requests, and supported HTTP methods.

Refer to the REST API Reference page for a list of the most used data entity requests.
See also request examples.