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

revokeTestDistributionAgentPoolRegistrationKey

@DELETE(value = "api/test-distribution/agent-pools/{poolId}/registration-keys/{keyPrefix}")
abstract suspend fun revokeTestDistributionAgentPoolRegistrationKey(@Path(value = "poolId") poolId: String, @Path(value = "keyPrefix") keyPrefix: String)

Revoke a Test Distribution pool-specific agent registration key. Revoke the Test Distribution pool-specific agent registration key for the given prefix which uniquely identifies a Test Distribution pool-specific agent registration key. A revoked key can no longer be used to connect agents, but it will still be queryable and returned in the list. Responses:

  • 200: The registration key was revoked successfully.

  • 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

Unit

Parameters

poolId

The ID of the pool to view.

keyPrefix

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