Agent
Represents a known agent instance.
Related Help article: Build Agent
Field | Data type | Allowed values |
|---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
|
|
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.
XML
JSON
<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" changesCollectingInProgress="true" 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>
<buildType>buildType...</buildType>
<comment>comment...</comment>
<tags>tags...</tags>
<pinInfo>comment...</pinInfo>
<user>user...</user>
<delayedByBuild>build...</delayedByBuild>
<plannedAgent>agent...</plannedAgent>
<approvalInfo>approvalInfo...</approvalInfo>
<running-info>progress-info...</running-info>
<canceledInfo>comment...</canceledInfo>
<triggered>TriggeredBy...</triggered>
<lastChanges>changes...</lastChanges>
<changes>changes...</changes>
<revisions>Revisions...</revisions>
<versionedSettingsRevision>Revision...</versionedSettingsRevision>
<artifactDependencyChanges>buildChanges...</artifactDependencyChanges>
<agent>agent...</agent>
<compatibleAgents>agents...</compatibleAgents>
<compatibleCloudImages>cloudImages...</compatibleCloudImages>
<testOccurrences>testOccurrences...</testOccurrences>
<problemOccurrences>problemOccurrences...</problemOccurrences>
<artifacts>files...</artifacts>
<relatedIssues>issuesUsages...</relatedIssues>
<properties>properties...</properties>
<resultingProperties>properties...</resultingProperties>
<originalProperties>properties...</originalProperties>
<startProperties>properties...</startProperties>
<attributes>entries...</attributes>
<statistics>properties...</statistics>
<metadata>datas...</metadata>
<snapshot-dependencies>builds...</snapshot-dependencies>
<artifact-dependencies>builds...</artifact-dependencies>
<custom-artifact-dependencies>artifact-dependencies...</custom-artifact-dependencies>
<replacementIds>items...</replacementIds>
<related>related...</related>
<triggeringOptions>buildTriggeringOptions...</triggeringOptions>
<statusChangeComment>comment...</statusChangeComment>
<vcsLabels>vcsLabel...</vcsLabels>
<customization>customizations...</customization>
<queuedWaitReasons>properties...</queuedWaitReasons>
<downloadedArtifacts>downloadedArtifacts...</downloadedArtifacts>
<firstBuildWithSameChanges>build...</firstBuildWithSameChanges>
</build>
<links count="123">
<link>link...</link>
</links>
<enabledInfo status="true" statusSwitchTime="string">
<comment>comment...</comment>
</enabledInfo>
<authorizedInfo status="true">
<comment>comment...</comment>
</authorizedInfo>
<properties count="123" href="string">
<property>property...</property>
</properties>
<cloudInstance errorMessage="string" href="string" id="string" name="string" networkAddress="string" startDate="string" state="string">
<image>cloudImage...</image>
<agent>agent...</agent>
</cloudInstance>
<cloudImage agentPoolId="123" agentTypeId="123" errorMessage="string" href="string" id="string" locator="string" name="string" operatingSystemName="string">
<profile>cloudProfile...</profile>
<instances>cloudInstances...</instances>
</cloudImage>
<environment osName="string" osType="string"/>
<pool href="string" id="123" locator="string" maxAgents="123" name="string">
<ownerProject>project...</ownerProject>
<projects>projects...</projects>
<agents>agents...</agents>
</pool>
<compatibilityPolicy policy="string">
<buildTypes>buildTypes...</buildTypes>
</compatibilityPolicy>
<compatibleBuildTypes count="123" href="string" nextHref="string" prevHref="string">
<buildType>buildType...</buildType>
</compatibleBuildTypes>
<incompatibleBuildTypes count="123">
<compatibility>compatibility...</compatibility>
</incompatibleBuildTypes>
<builds count="123" href="string" nextHref="string" prevHref="string">
<build>build...</build>
</builds>
</agent>{
"disconnectionComment" : "disconnectionComment",
"idleSinceTime" : "idleSinceTime",
"enabledInfo" : {
"statusSwitchTime" : "statusSwitchTime",
"comment" : {
"text" : "text",
"user" : "user...",
"timestamp" : "timestamp"
},
"status" : true
},
"cpuRank" : 3,
"enabled" : true,
"compatibleBuildTypes" : {
"buildType" : [ "buildType..." ],
"count" : 3,
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"protocol" : "unidirectional",
"outdated" : true,
"authorized" : true,
"host" : "host",
"builds" : {
"build" : [ {
"agent" : "agent...",
"metadata" : "datas...",
"triggered" : "TriggeredBy...",
"usedByOtherBuilds" : true,
"settingsHash" : "settingsHash",
"number" : "number",
"chainModificationId" : "chainModificationId",
"changesCollectingInProgress" : true,
"lastChanges" : "changes...",
"resultingProperties" : "properties...",
"composite" : true,
"links" : "links...",
"id" : 6,
"state" : "queued",
"href" : "href",
"detachedFromAgent" : true,
"compatibleCloudImages" : "cloudImages...",
"artifacts" : "files...",
"testOccurrences" : "testOccurrences...",
"artifactDependencyChanges" : "buildChanges...",
"startProperties" : "properties...",
"defaultBranch" : true,
"compatibleAgents" : "agents...",
"artifact-dependencies" : "builds...",
"replacementIds" : "items...",
"personal" : true,
"history" : true,
"tags" : "tags...",
"canceledInfo" : "comment...",
"running-info" : "progress-info...",
"versionedSettingsRevision" : "Revision...",
"percentageComplete" : 6,
"webUrl" : "webUrl",
"buildType" : "buildType...",
"triggeringOptions" : "buildTriggeringOptions...",
"locator" : "locator",
"startDate" : "startDate",
"status" : "status",
"pinned" : true,
"customized" : true,
"approvalInfo" : "approvalInfo...",
"vcsLabels" : [ "vcsLabel..." ],
"customization" : "customizations...",
"finishEstimate" : "finishEstimate",
"changes" : "changes...",
"plannedAgent" : "agent...",
"running" : true,
"statusChangeComment" : "comment...",
"finishOnAgentDate" : "finishOnAgentDate",
"buildTypeId" : "buildTypeId",
"buildTypeInternalId" : "buildTypeInternalId",
"originalProperties" : "properties...",
"modificationId" : "modificationId",
"related" : "related...",
"failedToStart" : true,
"revisions" : "Revisions...",
"delayedByBuild" : "build...",
"queuePosition" : 1,
"problemOccurrences" : "problemOccurrences...",
"artifactsDirectory" : "artifactsDirectory",
"relatedIssues" : "issuesUsages...",
"branchName" : "branchName",
"startEstimate" : "startEstimate",
"downloadedArtifacts" : "downloadedArtifacts...",
"limitedChangesCount" : 2,
"firstBuildWithSameChanges" : "build...",
"currentSettingsHash" : "currentSettingsHash",
"unspecifiedBranch" : true,
"queuedWaitReasons" : "properties...",
"waitReason" : "waitReason",
"pinInfo" : "comment...",
"snapshot-dependencies" : "builds...",
"statusText" : "statusText",
"custom-artifact-dependencies" : "artifact-dependencies...",
"comment" : "comment...",
"finishDate" : "finishDate",
"attributes" : "entries...",
"user" : "user...",
"queuedDate" : "queuedDate",
"taskId" : 3,
"properties" : "properties...",
"statistics" : "properties..."
} ],
"count" : 9,
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"links" : {
"count" : 5,
"link" : [ "link..." ]
},
"id" : 7,
"href" : "href",
"cloudImage" : {
"agentPoolId" : 7,
"instances" : "cloudInstances...",
"agentTypeId" : 5,
"profile" : "cloudProfile...",
"name" : "name",
"errorMessage" : "errorMessage",
"id" : "id",
"href" : "href",
"operatingSystemName" : "operatingSystemName",
"locator" : "locator"
},
"authorizedInfo" : {
"comment" : {
"text" : "text",
"user" : "user...",
"timestamp" : "timestamp"
},
"status" : true
},
"incompatibleBuildTypes" : {
"count" : 0,
"compatibility" : [ {
"compatible" : true,
"agent" : "agent...",
"buildType" : "buildType...",
"unmetRequirements" : "requirements..."
} ]
},
"uptodate" : true,
"ip" : "ip",
"pool" : {
"projects" : {
"count" : 6,
"project" : [ "project..." ],
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"maxAgents" : 4,
"ownerProject" : {
"virtual" : true,
"parentProjectName" : "parentProjectName",
"vcsRoots" : {
"count" : 4,
"vcs-root" : [ "vcs-root..." ],
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"projects" : {
"count" : 6,
"project" : [ "project..." ],
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"defaultTemplate" : {
"template" : "buildType...",
"paused" : true,
"description" : "description",
"project" : "project...",
"investigations" : "investigations...",
"templateFlag" : true,
"type" : "regular",
"uuid" : "uuid",
"projectInternalId" : "projectInternalId",
"internalId" : "internalId",
"features" : "features...",
"builds" : "builds...",
"links" : "links...",
"id" : "id",
"href" : "href",
"compatibleCloudImages" : "cloudImages...",
"settings" : "properties...",
"vcsRootInstances" : "vcs-root-instances...",
"templates" : "buildTypes...",
"artifact-dependencies" : "artifact-dependencies...",
"compatibleAgents" : "agents...",
"pauseComment" : "comment...",
"triggers" : "triggers...",
"branches" : "branches...",
"steps" : "steps...",
"externalStatusAllowed" : true,
"agent-requirements" : "agent-requirements...",
"webUrl" : "webUrl",
"inherited" : true,
"snapshot-dependencies" : "snapshot-dependencies...",
"name" : "name",
"vcs-root-entries" : "vcs-root-entries...",
"projectName" : "projectName",
"projectId" : "projectId",
"parameters" : "properties...",
"locator" : "locator"
},
"description" : "description",
"uuid" : "uuid",
"parentProjectInternalId" : "parentProjectInternalId",
"cloudProfiles" : {
"count" : 4,
"prevHref" : "prevHref",
"href" : "href",
"cloudProfile" : [ "cloudProfile..." ],
"nextHref" : "nextHref"
},
"internalId" : "internalId",
"archived" : true,
"parentProjectId" : "parentProjectId",
"links" : {
"count" : 5,
"link" : [ "link..." ]
},
"id" : "id",
"href" : "href",
"parentProject" : {
"virtual" : true,
"parentProjectName" : "parentProjectName",
"vcsRoots" : "vcs-roots...",
"projects" : "projects...",
"defaultTemplate" : "buildType...",
"description" : "description",
"uuid" : "uuid",
"parentProjectInternalId" : "parentProjectInternalId",
"cloudProfiles" : "cloudProfiles...",
"internalId" : "internalId",
"archived" : true,
"parentProjectId" : "parentProjectId",
"links" : "links...",
"id" : "id",
"href" : "href",
"parentProject" : "project...",
"templates" : "buildTypes...",
"readOnlyUI" : "StateField...",
"webUrl" : "webUrl",
"buildTypes" : "buildTypes...",
"name" : "name",
"ancestorProjects" : "projects...",
"parameters" : "properties...",
"projectFeatures" : "projectFeatures...",
"locator" : "locator"
},
"templates" : {
"buildType" : [ "buildType..." ],
"count" : 3,
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"readOnlyUI" : {
"inherited" : true,
"value" : true
},
"webUrl" : "webUrl",
"buildTypes" : {
"buildType" : [ "buildType..." ],
"count" : 3,
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"name" : "name",
"ancestorProjects" : {
"count" : 6,
"project" : [ "project..." ],
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"parameters" : {
"property" : [ {
"inherited" : true,
"name" : "name",
"type" : "type...",
"value" : "value"
} ],
"count" : 2,
"href" : "href"
},
"projectFeatures" : {
"projectFeature" : [ "projectFeature..." ],
"count" : 0,
"href" : "href"
},
"locator" : "locator"
},
"name" : "name",
"id" : 8,
"href" : "href",
"locator" : "locator",
"agents" : {
"agent" : [ "agent..." ],
"count" : 0,
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
}
},
"cloudInstance" : {
"image" : {
"agentPoolId" : 7,
"instances" : "cloudInstances...",
"agentTypeId" : 5,
"profile" : "cloudProfile...",
"name" : "name",
"errorMessage" : "errorMessage",
"id" : "id",
"href" : "href",
"operatingSystemName" : "operatingSystemName",
"locator" : "locator"
},
"agent" : {
"disconnectionComment" : "disconnectionComment",
"idleSinceTime" : "idleSinceTime",
"enabledInfo" : "enabledInfo...",
"cpuRank" : 2,
"enabled" : true,
"compatibleBuildTypes" : "buildTypes...",
"protocol" : "unidirectional",
"outdated" : true,
"authorized" : true,
"host" : "host",
"builds" : "builds...",
"links" : "links...",
"id" : 0,
"href" : "href",
"cloudImage" : "cloudImage...",
"authorizedInfo" : "authorizedInfo...",
"incompatibleBuildTypes" : "compatibilities...",
"uptodate" : true,
"ip" : "ip",
"pool" : "agentPool...",
"cloudInstance" : "cloudInstance...",
"version" : "version",
"connected" : true,
"currentAgentVersion" : "currentAgentVersion",
"compatibilityPolicy" : "compatibilityPolicy...",
"registrationTimestamp" : "registrationTimestamp",
"environment" : "environment...",
"pluginsOutdated" : true,
"port" : 3,
"build" : "build...",
"webUrl" : "webUrl",
"name" : "name",
"typeId" : 3,
"lastActivityTime" : "lastActivityTime",
"locator" : "locator",
"properties" : "properties...",
"javaOutdated" : true
},
"name" : "name",
"errorMessage" : "errorMessage",
"id" : "id",
"state" : "state",
"href" : "href",
"networkAddress" : "networkAddress",
"startDate" : "startDate"
},
"version" : "version",
"connected" : true,
"currentAgentVersion" : "currentAgentVersion",
"compatibilityPolicy" : {
"buildTypes" : {
"buildType" : [ "buildType..." ],
"count" : 3,
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"policy" : "policy"
},
"registrationTimestamp" : "registrationTimestamp",
"environment" : {
"osType" : "osType",
"osName" : "osName"
},
"pluginsOutdated" : true,
"port" : 9,
"build" : {
"agent" : "agent...",
"metadata" : "datas...",
"triggered" : "TriggeredBy...",
"usedByOtherBuilds" : true,
"settingsHash" : "settingsHash",
"number" : "number",
"chainModificationId" : "chainModificationId",
"changesCollectingInProgress" : true,
"lastChanges" : "changes...",
"resultingProperties" : "properties...",
"composite" : true,
"links" : "links...",
"id" : 6,
"state" : "queued",
"href" : "href",
"detachedFromAgent" : true,
"compatibleCloudImages" : "cloudImages...",
"artifacts" : "files...",
"testOccurrences" : "testOccurrences...",
"artifactDependencyChanges" : "buildChanges...",
"startProperties" : "properties...",
"defaultBranch" : true,
"compatibleAgents" : "agents...",
"artifact-dependencies" : "builds...",
"replacementIds" : "items...",
"personal" : true,
"history" : true,
"tags" : "tags...",
"canceledInfo" : "comment...",
"running-info" : "progress-info...",
"versionedSettingsRevision" : "Revision...",
"percentageComplete" : 6,
"webUrl" : "webUrl",
"buildType" : "buildType...",
"triggeringOptions" : "buildTriggeringOptions...",
"locator" : "locator",
"startDate" : "startDate",
"status" : "status",
"pinned" : true,
"customized" : true,
"approvalInfo" : "approvalInfo...",
"vcsLabels" : [ "vcsLabel..." ],
"customization" : "customizations...",
"finishEstimate" : "finishEstimate",
"changes" : "changes...",
"plannedAgent" : "agent...",
"running" : true,
"statusChangeComment" : "comment...",
"finishOnAgentDate" : "finishOnAgentDate",
"buildTypeId" : "buildTypeId",
"buildTypeInternalId" : "buildTypeInternalId",
"originalProperties" : "properties...",
"modificationId" : "modificationId",
"related" : "related...",
"failedToStart" : true,
"revisions" : "Revisions...",
"delayedByBuild" : "build...",
"queuePosition" : 1,
"problemOccurrences" : "problemOccurrences...",
"artifactsDirectory" : "artifactsDirectory",
"relatedIssues" : "issuesUsages...",
"branchName" : "branchName",
"startEstimate" : "startEstimate",
"downloadedArtifacts" : "downloadedArtifacts...",
"limitedChangesCount" : 2,
"firstBuildWithSameChanges" : "build...",
"currentSettingsHash" : "currentSettingsHash",
"unspecifiedBranch" : true,
"queuedWaitReasons" : "properties...",
"waitReason" : "waitReason",
"pinInfo" : "comment...",
"snapshot-dependencies" : "builds...",
"statusText" : "statusText",
"custom-artifact-dependencies" : "artifact-dependencies...",
"comment" : "comment...",
"finishDate" : "finishDate",
"attributes" : "entries...",
"user" : "user...",
"queuedDate" : "queuedDate",
"taskId" : 3,
"properties" : "properties...",
"statistics" : "properties..."
},
"webUrl" : "webUrl",
"name" : "name",
"typeId" : 3,
"lastActivityTime" : "lastActivityTime",
"locator" : "locator",
"properties" : {
"property" : [ {
"inherited" : true,
"name" : "name",
"type" : "type...",
"value" : "value"
} ],
"count" : 2,
"href" : "href"
},
"javaOutdated" : true
}Thanks for your feedback!
Was this page helpful?