TeamCity REST API Reference 2026.2 Help

LicensingData

Represents license state details (available build configurations, agents, etc.).

Properties

licenseUseExceeded

Indicates whether the number of used build configurations or pipelines exceeds the licensed limit.

maxAgents

The maximum number of authorized build agents across all active license keys. Absent when unlimitedAgents is true.

unlimitedAgents

Indicates whether the server is licensed for an unlimited number of build agents.

maxBuildTypes

The maximum number of authorized build configurations across all active license keys. Absent when unlimitedBuildTypes is true.

unlimitedBuildTypes

Indicates whether the server is licensed for an unlimited number of build configurations.

buildTypesLeft

The number of remaining build configuration licenses available for use.

maxPipelines

The maximum number of authorized pipelines across all active license keys. Absent when unlimitedPipelines is true.

unlimitedPipelines

Indicates whether the server is licensed for an unlimited number of pipelines.

pipelinesLeft

The number of remaining pipeline licenses available for use.

serverLicenseType

The overall license type of the server, determined by the combination of active license keys.

serverEffectiveReleaseDate

The effective release date of the server used when validating license maintenance periods, in the format yyyyMMddTHHmmssZ.

agentsLeft

The number of remaining build agent licenses available for use.

licenseKeys

The list of license keys associated with this server.

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.

<licensingData agentsLeft="5" buildTypesLeft="42" licenseUseExceeded="false" maxAgents="10" maxBuildTypes="100" maxPipelines="50" pipelinesLeft="20" serverEffectiveReleaseDate="20240101T000000+0000" serverLicenseType="enterprise" unlimitedAgents="false" unlimitedBuildTypes="true" unlimitedPipelines="true"> <licenseKeys count="3" href="/app/rest/server/licensingData/licenseKeys"> <licenseKey>[[[licenseKey...|licensekey.html]]]</licenseKey> </licenseKeys> </licensingData>
{ "maxPipelines" : 50, "unlimitedBuildTypes" : true, "pipelinesLeft" : 20, "unlimitedAgents" : false, "unlimitedPipelines" : true, "licenseUseExceeded" : false, "buildTypesLeft" : 42, "maxBuildTypes" : 100, "licenseKeys" : { "licenseKey" : [ { "rawType" : "0", "unlimitedBuildTypes" : true, "obsolete" : false, "active" : true, "unlimitedAgents" : false, "type" : "commercial", "unlimitedPipelines" : true, "agents" : 10, "valid" : true, "maintenanceEndDate" : "20261231T000000+0000", "expired" : false, "servers" : 1, "pipelines" : 50, "buildTypes" : 100, "key" : "XXXX-XXXX-XXXX-XXXX", "expirationDate" : "20261231T000000+0000", "errorDetails" : "License key is expired" } ], "count" : 3, "href" : "/app/rest/server/licensingData/licenseKeys" }, "serverLicenseType" : "enterprise", "serverEffectiveReleaseDate" : "20240101T000000+0000", "maxAgents" : 10, "agentsLeft" : 5 }
Last modified: 18 August 2026