TeamCity REST API Reference 2023.05 Help

LicensingData

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

Properties

Field

Data type

Allowed values

licenseUseExceeded

boolean

maxAgents

integer

unlimitedAgents

boolean

maxBuildTypes

integer

unlimitedBuildTypes

boolean

buildTypesLeft

integer

serverLicenseType

string

  • evaluation

  • eap

  • open_source

  • commercial

  • enterprise

  • professional

serverEffectiveReleaseDate

string

agentsLeft

integer

licenseKeys

LicenseKeys

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="123" buildTypesLeft="123" licenseUseExceeded="true" maxAgents="123" maxBuildTypes="123" serverEffectiveReleaseDate="string" serverLicenseType="string" unlimitedAgents="true" unlimitedBuildTypes="true"> <licenseKeys count="123" href="string"> <licenseKey>[[[licenseKey...|licensekey.html]]]</licenseKey> </licenseKeys> </licensingData>
{ "licenseUseExceeded" : true, "buildTypesLeft" : 2, "maxBuildTypes" : 0, "licenseKeys" : { "licenseKey" : [ { "rawType" : "rawType", "unlimitedBuildTypes" : true, "obsolete" : true, "active" : true, "unlimitedAgents" : true, "type" : "evaluation", "agents" : 4, "valid" : true, "maintenanceEndDate" : "maintenanceEndDate", "expired" : true, "servers" : 6, "buildTypes" : 8, "key" : "key", "expirationDate" : "expirationDate", "errorDetails" : "errorDetails" } ], "count" : 2, "href" : "href" }, "serverLicenseType" : "evaluation", "serverEffectiveReleaseDate" : "serverEffectiveReleaseDate", "maxAgents" : 6, "unlimitedBuildTypes" : true, "unlimitedAgents" : true, "agentsLeft" : 5 }
Last modified: 22 May 2023