TeamCity REST API Reference 2024.07 Help

AgentPools

Represents a paginated list of AgentPool entities.

Properties

count

The current number of AgentPool objects in this list.

href

The relative link (without the server URL) used to retrieve this object.

nextHref

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.

prevHref

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.

agentPool

The list of AgentPools owned by this collection.

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.

<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.html]]]</agentPool> </agentPools>
{ "count" : 7, "prevHref" : "/app/rest/agentPools?locator=count:50,start:0", "href" : "/app/rest/agentPools", "agentPool" : [ { "projects" : { "count" : 1, "project" : [ "[[[project...|project.html]]]" ], "prevHref" : "prevHref", "href" : "href", "nextHref" : "nextHref" }, "maxAgents" : 10, "ownerProject" : { "virtual" : true, "parentProjectName" : "parentProjectName", "vcsRoots" : { "count" : 0, "vcs-root" : [ "[[[vcs-root...|vcsroot.html]]]" ], "prevHref" : "prevHref", "href" : "href", "nextHref" : "nextHref" }, "projects" : { "count" : 1, "project" : [ "[[[project...|project.html]]]" ], "prevHref" : "prevHref", "href" : "href", "nextHref" : "nextHref" }, "defaultTemplate" : { "template" : "[[[buildType...|buildtype.html]]]", "paused" : true, "description" : "description", "project" : "[[[project...|project.html]]]", "investigations" : "[[[investigations...|investigations.html]]]", "templateFlag" : true, "type" : "regular", "uuid" : "uuid", "projectInternalId" : "projectInternalId", "internalId" : "internalId", "features" : "[[[features...|features.html]]]", "builds" : "[[[builds...|builds.html]]]", "links" : "[[[links...|links.html]]]", "id" : "id", "href" : "href", "compatibleCloudImages" : "[[[cloudImages...|cloudimages.html]]]", "settings" : "[[[properties...|properties.html]]]", "vcsRootInstances" : "[[[vcs-root-instances...|vcsrootinstances.html]]]", "templates" : "[[[buildTypes...|buildtypes.html]]]", "artifact-dependencies" : "[[[artifact-dependencies...|artifactdependencies.html]]]", "compatibleAgents" : "[[[agents...|agents.html]]]", "pauseComment" : "[[[comment...|comment.html]]]", "triggers" : "[[[triggers...|triggers.html]]]", "branches" : "[[[branches...|branches.html]]]", "steps" : "[[[steps...|steps.html]]]", "externalStatusAllowed" : true, "agent-requirements" : "[[[agent-requirements...|agentrequirements.html]]]", "webUrl" : "webUrl", "inherited" : true, "snapshot-dependencies" : "[[[snapshot-dependencies...|snapshotdependencies.html]]]", "name" : "name", "vcs-root-entries" : "[[[vcs-root-entries...|vcsrootentries.html]]]", "projectName" : "projectName", "projectId" : "projectId", "parameters" : "[[[properties...|properties.html]]]", "locator" : "locator" }, "description" : "description", "uuid" : "uuid", "parentProjectInternalId" : "parentProjectInternalId", "cloudProfiles" : { "count" : 8, "prevHref" : "prevHref", "href" : "href", "cloudProfile" : [ "[[[cloudProfile...|cloudprofile.html]]]" ], "nextHref" : "nextHref" }, "internalId" : "internalId", "archived" : true, "parentProjectId" : "parentProjectId", "deploymentDashboards" : { "count" : 3, "deploymentDashboard" : [ "[[[deploymentDashboard...|deploymentdashboard.html]]]" ], "prevHref" : "prevHref", "href" : "href", "nextHref" : "nextHref" }, "links" : { "count" : 8, "link" : [ "[[[link...|link.html]]]" ] }, "id" : "id", "href" : "href", "parentProject" : { "virtual" : true, "parentProjectName" : "parentProjectName", "vcsRoots" : "[[[vcs-roots...|vcsroots.html]]]", "projects" : "[[[projects...|projects.html]]]", "defaultTemplate" : "[[[buildType...|buildtype.html]]]", "description" : "description", "uuid" : "uuid", "parentProjectInternalId" : "parentProjectInternalId", "cloudProfiles" : "[[[cloudProfiles...|cloudprofiles.html]]]", "internalId" : "internalId", "archived" : true, "parentProjectId" : "parentProjectId", "deploymentDashboards" : "[[[deploymentDashboards...|deploymentdashboards.html]]]", "links" : "[[[links...|links.html]]]", "id" : "id", "href" : "href", "parentProject" : "[[[project...|project.html]]]", "templates" : "[[[buildTypes...|buildtypes.html]]]", "readOnlyUI" : "[[[StateField...|statefield.html]]]", "webUrl" : "webUrl", "buildTypes" : "[[[buildTypes...|buildtypes.html]]]", "name" : "name", "ancestorProjects" : "[[[projects...|projects.html]]]", "parameters" : "[[[properties...|properties.html]]]", "projectFeatures" : "[[[projectFeatures...|projectfeatures.html]]]", "locator" : "locator" }, "templates" : { "buildType" : [ "[[[buildType...|buildtype.html]]]" ], "count" : 4, "prevHref" : "prevHref", "href" : "href", "nextHref" : "nextHref" }, "readOnlyUI" : { "inherited" : true, "value" : true }, "webUrl" : "webUrl", "buildTypes" : { "buildType" : [ "[[[buildType...|buildtype.html]]]" ], "count" : 4, "prevHref" : "prevHref", "href" : "href", "nextHref" : "nextHref" }, "name" : "name", "ancestorProjects" : { "count" : 1, "project" : [ "[[[project...|project.html]]]" ], "prevHref" : "prevHref", "href" : "href", "nextHref" : "nextHref" }, "parameters" : { "count" : 1, "property" : [ { "inherited" : true, "name" : "name", "type" : "[[[type...|type.html]]]", "value" : "value" } ], "href" : "href" }, "projectFeatures" : { "projectFeature" : [ "[[[projectFeature...|projectfeature.html]]]" ], "count" : 2, "href" : "href" }, "locator" : "locator" }, "name" : "Kubernetes", "id" : 31, "href" : "/app/rest/agentPools/id:82", "locator" : "locator", "agents" : { "agent" : [ "[[[agent...|agent.html]]]" ], "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...|agenttype.html]]]" ], "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" }
Last modified: 23 September 2024