library/com.gabrielfeo.develocity.api/TestDistributionApi/insertTestDistributionAgentPoolRegistrationKey

insertTestDistributionAgentPoolRegistrationKey

@PUT(value = "api/test-distribution/agent-pools/{poolId}/registration-keys/{keyPrefix}")
abstract suspend fun insertTestDistributionAgentPoolRegistrationKey(@Path(value = "poolId") poolId: String, @Path(value = "keyPrefix") keyPrefix: String, @Body testDistributionAgentPoolRegistrationKey: TestDistributionAgentPoolRegistrationKey): TestDistributionAgentPoolRegistrationKeyPrefix

Insert a specific Test Distribution pool-specific agent registration key. Inserts a specific Test Distribution pool-specific agent registration key to connect agents and query the agent pool API. If a key with the same prefix but different key already exists (regardless of which pool it belongs to), it will return 400. Responses:

  • 200: The registration key was successfully inserted.

  • 400: The request body is malformed or contains invalid values for at least one of the properties.

  • 403: The authenticated user has insufficient permissions.

  • 404: No API key was specified in the request, the key has been revoked, or the user bearing the key lacks permissions for this operation.

Return

TestDistributionAgentPoolRegistrationKeyPrefix

Parameters

poolId

The ID of the pool to view.

keyPrefix

The prefix of the Test Distribution pool-specific agent registration key.

testDistributionAgentPoolRegistrationKey