From f7cb7b4ef8f27673977ddbbcbf0c8cf396385dd4 Mon Sep 17 00:00:00 2001 From: Henryk Date: Thu, 14 Nov 2024 17:29:26 -0600 Subject: [PATCH] Added clarification on returned elements as requested in 166990 --- website/docs/cloud-docs/api-docs/agents.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/website/docs/cloud-docs/api-docs/agents.mdx b/website/docs/cloud-docs/api-docs/agents.mdx index 7e487084d..712bd3877 100644 --- a/website/docs/cloud-docs/api-docs/agents.mdx +++ b/website/docs/cloud-docs/api-docs/agents.mdx @@ -73,6 +73,14 @@ This endpoint supports pagination [with standard URL query parameters](/terrafor | `page[size]` | **Optional.** If omitted, the endpoint will return 20 agent pools per page. | | `filter[allowed_workspaces][name]` | **Optional.** Filters agent pools to those associated with the given workspace. The workspace must have permission to use the agent pool. Refer to [Scoping Agent Pools to Specific Workspaces](/terraform/cloud-docs/agents#scope-an-agent-pool-to-specific-workspaces). | | + +### Comments on response elements +| Key path | Type | Description | +|-------------------------------------------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------| +| `data.attributes.agent-count` | number | Number of agents in Idle, Busy or Unknown state. Agents in Exited or Errored are excluded as they already exited, either gracefully or not. | +| `data.attributes.meta.status-counts.total` | number | Total number of resources filter was applied to. | +| `data.attributes.meta.status-counts.matching` | number | Total number of resources matching the applied filter and therefore returned. | + ### Sample Request ```shell