DEdevelocity
TestDistribution
GradleEnterprise
Develocity

View the properties of an Agent Pool

View the identifier, capabilities and size of an Agent Pool.

get/api/test-distribution/agent-pools/{poolId}

Request

Response

The poolId referenced an existing Agent Pool whose configuration is described in the response.

idstring required

The unique identifier of the agent pool.

namestring required

The alias or display name of the agent pool.

minimumSizeinteger required
maximumSizeinteger required
orderIndexinteger required

The order in which the agent pool is considered for allocation. Lower values are considered first.

capabilitiesstring[] required
restrictAccessToProjectGroupsboolean

Controls whether this pool can be used by everyone, or only the assigned project groups. A true value implies that projectGroupIds is present and has at least one entry. Conversely, a false value implies that projectGroupIds is empty.

projectGroupIdsstring[]

Controls which project groups can use this pool. If it is empty, then restrictAccessToProjectGroups must be false. Conversely, if it has values then restrictAccessToProjectGroups must be true.

Example response

{
  "name": "functional-test-agents",
  "capabilities": [
    "jdk=17",
    "os=linux",
    "functional-test"
  ],
  "projectGroupIds": [
    "project-group-a"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.