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

insertTestDistributionApiKey

@PUT(value = "api/test-distribution/api-keys/{keyPrefix}")
abstract suspend fun insertTestDistributionApiKey(@Path(value = "keyPrefix") keyPrefix: String, @Body testDistributionApiKey: TestDistributionApiKey): TestDistributionApiKeyPrefix

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

  • 200: The API 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

TestDistributionApiKeyPrefix

Parameters

keyPrefix

The prefix of the Test Distribution API key.

testDistributionApiKey