AgentPools
Represents a paginated list of AgentPool entities.
tip
Data type:
integer
Example:7
The current number of AgentPool objects in this list.
tip
Data type:
string
Example:/app/rest/agentPools
The relative link (without the server URL) used to retrieve this object.
tip
Data type:
string
Example:/app/rest/agentPools?locator=count:200,start:250
If the list of returned entities exceeds the request `count` value, TeamCity splits it into multiple batches. This property returns the endpoint that allows you to obtain the next batch.
tip
Data type:
string
Example:/app/rest/agentPools?locator=count:50,start:0
If the list of returned entities exceeds the request `count` value, TeamCity splits it into multiple batches. This property returns the endpoint that allows you to obtain the previous batch.
tip
Data type:
List<AgentPool>
Example:
The list of AgentPools owned by this collection.
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.
<agentPools count="7" href="/app/rest/agentPools" nextHref="/app/rest/agentPools?locator=count:200,start:250" prevHref="/app/rest/agentPools?locator=count:50,start:0">
<agentPool>agentPool...</agentPool>
</agentPools>{
"count" : 7,
"prevHref" : "/app/rest/agentPools?locator=count:50,start:0",
"href" : "/app/rest/agentPools",
"agentPool" : [ {
"projects" : {
"count" : 4,
"project" : [ "project..." ],
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"maxAgents" : 10,
"ownerProject" : {
"virtual" : true,
"parentProjectName" : "parentProjectName",
"vcsRoots" : {
"count" : 8,
"vcs-root" : [ "vcs-root..." ],
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"projects" : {
"count" : 4,
"project" : [ "project..." ],
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"defaultTemplate" : {
"template" : "buildType...",
"paused" : true,
"output-parameters" : "properties...",
"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" : 8,
"prevHref" : "prevHref",
"href" : "href",
"cloudProfile" : [ "cloudProfile..." ],
"nextHref" : "nextHref"
},
"internalId" : "internalId",
"archived" : true,
"parentProjectId" : "parentProjectId",
"deploymentDashboards" : {
"count" : 1,
"deploymentDashboard" : [ "deploymentDashboard..." ],
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"links" : {
"count" : 0,
"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",
"deploymentDashboards" : "deploymentDashboards...",
"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" : 2,
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"readOnlyUI" : {
"inherited" : true,
"value" : true
},
"webUrl" : "webUrl",
"buildTypes" : {
"buildType" : [ "buildType..." ],
"count" : 2,
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"name" : "name",
"ancestorProjects" : {
"count" : 4,
"project" : [ "project..." ],
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"parameters" : {
"count" : 1,
"property" : [ {
"inherited" : true,
"name" : "name",
"type" : "type...",
"value" : "value"
} ],
"href" : "href"
},
"projectFeatures" : {
"projectFeature" : [ "projectFeature..." ],
"count" : 6,
"href" : "href"
},
"locator" : "locator"
},
"name" : "Kubernetes",
"id" : 31,
"href" : "/app/rest/agentPools/id:82",
"locator" : "locator",
"agents" : {
"agent" : [ "agent..." ],
"count" : 7,
"prevHref" : "/app/rest/agents?locator=count:50,start:0",
"href" : "/app/rest/agents",
"nextHref" : "/app/rest/agents?locator=count:200,start:250"
},
"agentTypes" : {
"agentType" : [ "agentType..." ],
"count" : 1,
"prevHref" : "/app/rest/agentTypes?locator=count:50,start:0",
"href" : "/app/rest/agentTypes",
"nextHref" : "/app/rest/agentTypes?locator=count:200,start:250"
}
} ],
"nextHref" : "/app/rest/agentPools?locator=count:200,start:250"
}