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

getTestDistributionAgentPoolStatus

@GET(value = "api/test-distribution/agent-pools/{poolId}/status")
abstract suspend fun getTestDistributionAgentPoolStatus(@Path(value = "poolId") poolId: String): TestDistributionAgentPoolStatus

View the status of an Agent Pool View the status of an Agent Pool, such as its current size. To access this endpoint the user requires the `Test Distribution` permission. Responses:

  • 200: The poolId referenced an existing Agent Pool whose status is described 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

TestDistributionAgentPoolStatus

Parameters

poolId

The ID of the pool to view.