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

generateTestDistributionAgentPoolRegistrationKey

@POST(value = "api/test-distribution/agent-pools/{poolId}/registration-keys")
abstract suspend fun generateTestDistributionAgentPoolRegistrationKey(@Path(value = "poolId") poolId: String, @Body testDistributionAgentPoolRegistrationKeyDescription: TestDistributionAgentPoolRegistrationKeyDescription? = null): TestDistributionAgentPoolRegistrationKey

Generate a new Test Distribution pool-specific agent registration key. Generate a new Test Distribution pool-specific agent registration key to connect agents and query the agent pool API. Responses:

  • 200: A new registration key was successfully generated and contained in the response.

  • 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

TestDistributionAgentPoolRegistrationKey

Parameters

poolId

The ID of the pool to view.

testDistributionAgentPoolRegistrationKeyDescription

(optional)