AgentPool
Represents an agent pool instance.
Related Help article: Agent Pool
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
<agentPool href="string" id="123" locator="string" maxAgents="123" name="string">
<ownerProject archived="true" description="string" href="string" id="string" internalId="string" locator="string" name="string" parentProjectId="string" parentProjectInternalId="string" parentProjectName="string" uuid="string" virtual="true" webUrl="string">
<links>links...</links>
<parentProject>project...</parentProject>
<readOnlyUI>StateField...</readOnlyUI>
<defaultTemplate>buildType...</defaultTemplate>
<buildTypes>buildTypes...</buildTypes>
<templates>buildTypes...</templates>
<parameters>properties...</parameters>
<vcsRoots>vcs-roots...</vcsRoots>
<projectFeatures>projectFeatures...</projectFeatures>
<projects>projects...</projects>
<cloudProfiles>cloudProfiles...</cloudProfiles>
<ancestorProjects>projects...</ancestorProjects>
</ownerProject>
<projects count="123" href="string" nextHref="string" prevHref="string">
<project>project...</project>
</projects>
<agents count="123" href="string" nextHref="string" prevHref="string">
<agent>agent...</agent>
</agents>
</agentPool>{
"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"
}
}Thanks for your feedback!
Was this page helpful?