TeamCity REST API Reference 2025.11 Help

Server

Stores extensive information about the current TeamCity server instance.

Properties

version

The full TeamCity server version, including the build number and, if present, the EAP (early access preview) flag.

versionMajor

The major TeamCity version that points to the year when this version was released.

versionMinor

The major TeamCity version that points to the month of versionMajor when this version was released.

startTime

The most recent date this TeamCity server was started.

currentTime

The current TeamCity server time, which corresponds to the server's machine time.

buildNumber

The TeamCity build number.

buildDate

The date when this TeamCity version was built by JetBrains.

internalId

The internally used read-only server ID.

role

In a multi-node setup, returns the role of the current TeamCity server. Returns main_node for single-node setups.

webUrl

Returns the regular web URL of the server, including the server port.

projects

The relative (without TeamCity server URL) endpoint that allows you to access projects managed by this server.

vcsRoots

The relative (without TeamCity server URL) endpoint that allows you to access VCS roots owned by this server.

builds

The relative (without TeamCity server URL) endpoint that allows you to access builds processed by this server.

users

The relative (without TeamCity server URL) endpoint that allows you to view and edit users of this server.

userGroups

The relative (without TeamCity server URL) endpoint that allows you to view and edit usergroups.

agents

The relative (without TeamCity server URL) endpoint that allows you to access build agents connected to this server.

buildQueue

The relative (without TeamCity server URL) endpoint that allows you to access a build queue managed by this server.

agentPools

The relative (without TeamCity server URL) endpoint that allows you to access agent pools.

investigations

The relative (without TeamCity server URL) endpoint that allows you to access problem investigations.

mutes

The relative (without TeamCity server URL) endpoint that allows you to access muted problems.

artifactsUrl

Returns the artifacts isolation URL: the URL of a separate domain that stores build artifacts and mitigates the risk of TeamCity server attacks carried out by users who access these artifacts. If the isolation URL is not set (default setup), returns an empty string.

nodes

The relative (without TeamCity server URL) endpoint that allows you to access all nodes of a setup to which the current server belongs.

Schema

Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.

A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.

<server artifactsUrl="string" buildDate="20250514T000000+0200" buildNumber="194451" currentTime="20250522T122203+0200" internalId="5218cd10a-9ed0-4e9c-9150-094039adadd0" role="main_node" startTime="20250515T114245+0200" version="2025.07 EAP (build 194451)" versionMajor="2025" versionMinor="7" webUrl="https://mybuild.farm.net:8111"> <projects href="string"/> <vcsRoots href="string"/> <builds href="string"/> <users href="string"/> <userGroups href="string"/> <agents href="string"/> <buildQueue href="string"/> <agentPools href="string"/> <investigations href="string"/> <mutes href="string"/> <nodes href="string"/> </server>
{ "role" : "main_node", "projects" : { "href" : "href" }, "vcsRoots" : { "href" : "href" }, "investigations" : { "href" : "href" }, "buildDate" : "20250514T000000+0200", "mutes" : { "href" : "href" }, "version" : "2025.07 EAP (build 194451)", "buildNumber" : "194451", "users" : { "href" : "href" }, "agents" : { "href" : "href" }, "currentTime" : "20250522T122203+0200", "internalId" : "5218cd10a-9ed0-4e9c-9150-094039adadd0", "userGroups" : { "href" : "href" }, "buildQueue" : { "href" : "href" }, "artifactsUrl" : "artifactsUrl", "nodes" : { "href" : "href" }, "webUrl" : "https://mybuild.farm.net:8111", "builds" : { "href" : "href" }, "startTime" : "20250515T114245+0200", "versionMajor" : 2025, "versionMinor" : 7, "agentPools" : { "href" : "href" } }
Last modified: 02 December 2025