Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added clarification on returned elements as requested in 166990 #783

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −0
Open

Added clarification on returned elements as requested in 166990 #783

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions website/docs/cloud-docs/api-docs/agents.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down