library/com.gabrielfeo.gradle.enterprise.api/TestDistributionApi/revokeTestDistributionApiKey

revokeTestDistributionApiKey

@DELETE(value = "api/test-distribution/api-keys/{keyPrefix}")
abstract suspend fun revokeTestDistributionApiKey(@Path(value = "keyPrefix") keyPrefix: String)

Revoke a Test Distribution API key. Revoke the Test Distribution API key for the given prefix which uniquely identifies a Test Distribution API 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 API 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

keyPrefix

The prefix of the Test Distribution API key.