TeamCity 2021.1 Help

Agent

Represents a known agent instance.

Related Help article: Build Agent

Properties

FieldData typeAllowed values

id

integer

name

string

typeId

integer

connected

boolean

enabled

boolean

authorized

boolean

uptodate

boolean

outdated

boolean

pluginsOutdated

boolean

javaOutdated

boolean

ip

string

protocol

string

  • unidirectional
  • bidirectional

version

string

currentAgentVersion

string

lastActivityTime

string

idleSinceTime

string

disconnectionComment

string

registrationTimestamp

string

host

string

cpuRank

integer

port

integer

href

string

webUrl

string

build

Build

links

Links

enabledInfo

EnabledInfo

authorizedInfo

AuthorizedInfo

properties

Properties

cloudInstance

CloudInstance

cloudImage

CloudImage

environment

Environment

pool

AgentPool

compatibilityPolicy

CompatibilityPolicy

compatibleBuildTypes

BuildTypes

incompatibleBuildTypes

Compatibilities

builds

Builds

locator

string

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.

<agent authorized="true" connected="true" cpuRank="123" currentAgentVersion="string" disconnectionComment="string" enabled="true" host="string" href="string" id="123" idleSinceTime="string" ip="string" javaOutdated="true" lastActivityTime="string" locator="string" name="string" outdated="true" pluginsOutdated="true" port="123" protocol="string" registrationTimestamp="string" typeId="123" uptodate="true" version="string" webUrl="string"> <build artifactsDirectory="string" branchName="string" buildTypeId="string" buildTypeInternalId="string" chainModificationId="string" composite="true" currentSettingsHash="string" customized="true" defaultBranch="true" detachedFromAgent="true" failedToStart="true" finishDate="string" finishEstimate="string" finishOnAgentDate="string" history="true" href="string" id="123456789" limitedChangesCount="123" locator="string" modificationId="string" number="string" percentageComplete="123" personal="true" pinned="true" queuePosition="123" queuedDate="string" running="true" settingsHash="string" startDate="string" startEstimate="string" state="string" status="string" statusText="string" taskId="123456789" unspecifiedBranch="true" usedByOtherBuilds="true" waitReason="string" webUrl="string"> <links>[[[links...|links.html]]]</links> <buildType>[[[buildType...|buildtype.html]]]</buildType> <comment>[[[comment...|comment.html]]]</comment> <tags>[[[tags...|tags.html]]]</tags> <pinInfo>[[[comment...|comment.html]]]</pinInfo> <user>[[[user...|user.html]]]</user> <running-info>[[[progress-info...|progressinfo.html]]]</running-info> <canceledInfo>[[[comment...|comment.html]]]</canceledInfo> <triggered>[[[TriggeredBy...|triggeredby.html]]]</triggered> <lastChanges>[[[changes...|changes.html]]]</lastChanges> <changes>[[[changes...|changes.html]]]</changes> <revisions>[[[Revisions...|revisions.html]]]</revisions> <versionedSettingsRevision>[[[Revision...|revision.html]]]</versionedSettingsRevision> <artifactDependencyChanges>[[[buildChanges...|buildchanges.html]]]</artifactDependencyChanges> <agent>[[[agent...|agent.html]]]</agent> <compatibleAgents>[[[agents...|agents.html]]]</compatibleAgents> <testOccurrences>[[[testOccurrences...|testoccurrences.html]]]</testOccurrences> <problemOccurrences>[[[problemOccurrences...|problemoccurrences.html]]]</problemOccurrences> <artifacts>[[[files...|files.html]]]</artifacts> <relatedIssues>[[[issuesUsages...|issuesusages.html]]]</relatedIssues> <properties>[[[properties...|properties.html]]]</properties> <resultingProperties>[[[properties...|properties.html]]]</resultingProperties> <attributes>[[[entries...|entries.html]]]</attributes> <statistics>[[[properties...|properties.html]]]</statistics> <metadata>[[[datas...|datas.html]]]</metadata> <snapshot-dependencies>[[[builds...|builds.html]]]</snapshot-dependencies> <artifact-dependencies>[[[builds...|builds.html]]]</artifact-dependencies> <custom-artifact-dependencies>[[[artifact-dependencies...|artifactdependencies.html]]]</custom-artifact-dependencies> <replacementIds>[[[items...|items.html]]]</replacementIds> <related>[[[related...|related.html]]]</related> <triggeringOptions>[[[buildTriggeringOptions...|buildtriggeringoptions.html]]]</triggeringOptions> <statusChangeComment>[[[comment...|comment.html]]]</statusChangeComment> <vcsLabels>[[[vcsLabel...|vcslabel.html]]]</vcsLabels> <customization>[[[customizations...|customizations.html]]]</customization> </build> <links count="123"> <link>[[[link...|link.html]]]</link> </links> <enabledInfo status="true" statusSwitchTime="string"> <comment>[[[comment...|comment.html]]]</comment> </enabledInfo> <authorizedInfo status="true"> <comment>[[[comment...|comment.html]]]</comment> </authorizedInfo> <properties count="123" href="string"> <property>[[[property...|property.html]]]</property> </properties> <cloudInstance errorMessage="string" href="string" id="string" name="string" networkAddress="string" startDate="string" state="string"> <image>[[[cloudImage...|cloudimage.html]]]</image> <agent>[[[agent...|agent.html]]]</agent> </cloudInstance> <cloudImage agentPoolId="123" agentTypeId="123" errorMessage="string" href="string" id="string" locator="string" name="string" operatingSystemName="string"> <profile>[[[cloudProfile...|cloudprofile.html]]]</profile> <instances>[[[cloudInstances...|cloudinstances.html]]]</instances> </cloudImage> <environment osName="string" osType="string"/> <pool href="string" id="123" locator="string" maxAgents="123" name="string"> <ownerProject>[[[project...|project.html]]]</ownerProject> <projects>[[[projects...|projects.html]]]</projects> <agents>[[[agents...|agents.html]]]</agents> </pool> <compatibilityPolicy policy="string"> <buildTypes>[[[buildTypes...|buildtypes.html]]]</buildTypes> </compatibilityPolicy> <compatibleBuildTypes count="123" href="string" nextHref="string" prevHref="string"> <buildType>[[[buildType...|buildtype.html]]]</buildType> </compatibleBuildTypes> <incompatibleBuildTypes count="123"> <compatibility>[[[compatibility...|compatibility.html]]]</compatibility> </incompatibleBuildTypes> <builds count="123" href="string" nextHref="string" prevHref="string"> <build>[[[build...|build.html]]]</build> </builds> </agent>
{ "disconnectionComment" : "disconnectionComment", "idleSinceTime" : "idleSinceTime", "enabledInfo" : "[[[enabledInfo...|enabledinfo.html]]]", "cpuRank" : 0, "enabled" : true, "compatibleBuildTypes" : "[[[buildTypes...|buildtypes.html]]]", "protocol" : "unidirectional", "outdated" : true, "authorized" : true, "host" : "host", "builds" : "[[[builds...|builds.html]]]", "links" : "[[[links...|links.html]]]", "id" : 9, "href" : "href", "cloudImage" : "[[[cloudImage...|cloudimage.html]]]", "authorizedInfo" : "[[[authorizedInfo...|authorizedinfo.html]]]", "incompatibleBuildTypes" : "[[[compatibilities...|compatibilities.html]]]", "uptodate" : true, "ip" : "ip", "pool" : "[[[agentPool...|agentpool.html]]]", "cloudInstance" : "[[[cloudInstance...|cloudinstance.html]]]", "version" : "version", "connected" : true, "currentAgentVersion" : "currentAgentVersion", "compatibilityPolicy" : "[[[compatibilityPolicy...|compatibilitypolicy.html]]]", "registrationTimestamp" : "registrationTimestamp", "environment" : "[[[environment...|environment.html]]]", "pluginsOutdated" : true, "port" : 5, "build" : "[[[build...|build.html]]]", "webUrl" : "webUrl", "name" : "name", "typeId" : 8, "lastActivityTime" : "lastActivityTime", "locator" : "locator", "properties" : "[[[properties...|properties.html]]]", "javaOutdated" : true }
Last modified: 25 May 2021