Create or update an Agent Pool.

Create a new Agent Pool in Develocity or update the configuration of an existing one. The orderIndex element is optional and can be used to specify the priority order in which the Agent Pool is considered. When not specified, the Agent Pool will be either added last on creation, or will not change position on update. When specified, the Agent Pool will be added at/moved to the specified index and all other Agent Pools will be moved down. If the specified index is out of bounds, the Agent Pool will be added last with the orderIndex adjusted accordingly.

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

Request

Base URL
https://develocity.example.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/develocity/apis/develocity-api/docs/api/test-distribution/agent-pools/:poolId/put.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

The alias or display name of the agent pool.

minimumSizeinteger required

maximumSizeinteger required

orderIndexinteger nullable

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 request

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

Response

The Agent Pool was created or its configuration was updated successfully.

idstring required

The unique identifier of the agent pool.