Skip to content

Commit d5d213e

Browse files
rkoron007rkoron007
committed
Add explict HCP TF sentences for Stacks
1 parent 8fc2687 commit d5d213e

File tree

1 file changed

+13
-13
lines changed
  • content/terraform-docs-common/docs/cloud-docs/api-docs

1 file changed

+13
-13
lines changed

‎content/terraform-docs-common/docs/cloud-docs/api-docs/agents.mdx‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ description: >-
3838

3939
# Agents and agent pools API reference
4040

41-
An Agent Pool represents a group of Agents, often related to one another by sharing a common network segment or purpose.
42-
A workspace<!-- BEGIN: TFC:only name:stacks-tfe --> or Stack<!-- END: TFC:only name:stacks-tfe --> may be configured to use one of the organization's agent pools to run remote operations with isolated,
43-
private, or on-premises infrastructure.
41+
An Agent Pool represents a group of Agents, often related to one another by sharing a common network segment or purpose. A workspace or Stack may be configured to use one of the organization's agent pools to run remote operations with isolated, private, or on-premises infrastructure.
42+
43+
Terraform Enterprise does not currently support Stacks, so any references to Stacks in the following API endpoints only apply to HCP Terraform.
4444

4545
<!-- BEGIN: TFC:only name:pnp-callout -->
4646
@include 'tfc-package-callouts/agents.mdx'
@@ -72,7 +72,7 @@ This endpoint supports pagination [with standard URL query parameters](/terrafor
7272
| `page[number]` | **Optional.** If omitted, the endpoint will return the first page. |
7373
| `page[size]` | **Optional.** If omitted, the endpoint will return 20 agent pools per page. |
7474
| `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). |
75-
| `filter[allowed_stacks][name]` | **Optional.** Filters agent pools to those associated with the given stack. The stack must have permission to use the agent pool. Refer to [Scoping Agent Pools to Specific Stacks](/terraform/cloud-docs/agents#scope-an-agent-pool-to-specific-stacks). |
75+
| `filter[allowed_stacks][name]` | **Optional.** Filters agent pools to those associated with the given Stack. The Stack must have permission to use the agent pool. Only available in HCP Terraform, refer to [Scope agent pools](/terraform/cloud-docs/agents#scope-an-agent-pool) to learn more. |
7676
| `filter[allowed_projects][name]` | **Optional.** Filters agent pools to those associated with the given project. The project must have permission to use the agent pool. Refer to [Scoping Agent Pools to Specific Projects](/terraform/cloud-docs/agents#scope-an-agent-pool-to-specific-projects). |
7777

7878

@@ -502,14 +502,14 @@ Properties without a default value are required.
502502
| `data.attributes.organization-scoped` | bool | true | The scope of the agent pool. If true, all workspaces in the organization can use the agent pool. |
503503
| `data.relationships.allowed-workspaces.data.type` | string | | Must be `"workspaces"`. |
504504
| `data.relationships.allowed-workspaces.data.id` | string | | The ID of the workspace that has 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). |
505-
| `data.relationships.allowed-stacks.data.type` | string | | Must be `"stacks"`. |
506-
| `data.relationships.allowed-stacks.data.id` | string | | The ID of the stack that has permission to use the agent pool. Refer to [Scoping Agent Pools to Specific Stacks](/terraform/cloud-docs/agents#scope-an-agent-pool-to-specific-stacks). |
505+
| `data.relationships.allowed-stacks.data.type` | string | | Must be `"stacks"`. Only available in HCP Terraform. |
506+
| `data.relationships.allowed-stacks.data.id` | string | | The ID of the stack that has permission to use the agent pool. Only available in HCP Terraform, refer to [Scope agent pools](/terraform/cloud-docs/agents#scope-an-agent-pool) to learn more. |
507507
| `data.relationships.allowed-projects.data.type` | string | | Must be `"projects"`. Refer to [Scoping Agent Pools to Specific Projects](/terraform/cloud-docs/agents#scope-an-agent-pool-to-specific-projects). |
508508
| `data.relationships.allowed-projects.data.id` | string | | The ID of the project that has permission to use the agent pool. |
509509
| `data.relationships.excluded-workspaces.data.type` | string | | Must be `"workspaces"`. |
510510
| `data.relationships.excluded-workspaces.data.id` | string | | The ID of the workspace that is excluded from the scope of the agent pool. |
511-
| `data.relationships.excluded-stacks.data.type` | string | | Must be `"stacks"`. |
512-
| `data.relationships.excluded-stacks.data.id` | string | | The ID of the stack that is excluded from the scope of the agent pool. |
511+
| `data.relationships.excluded-stacks.data.type` | string | | Must be `"stacks"`. Only available in HCP Terraform. |
512+
| `data.relationships.excluded-stacks.data.id` | string | | The ID of the Stack that is excluded from the scope of the agent pool. Only available in HCP Terraform. |
513513

514514
### Sample Payload
515515

@@ -683,14 +683,14 @@ Properties without a default value are required.
683683
| `data.attributes.organization-scoped` | bool | true | The scope of the agent pool. If true, all workspaces in the organization can use the agent pool. |
684684
| `data.relationships.allowed-workspaces.data.type` | string | | Must be `"workspaces"`. |
685685
| `data.relationships.allowed-workspaces.data.id` | string | | The ID of the workspace that has 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). |
686-
| `data.relationships.allowed-stacks.data.type` | string | | Must be `"stacks"`. |
687-
| `data.relationships.allowed-stacks.data.id` | string | | The ID of the stack that has permission to use the agent pool. Refer to [Scoping Agent Pools to Specific Stacks](/terraform/cloud-docs/agents#scope-an-agent-pool-to-specific-stacks). |
686+
| `data.relationships.allowed-stacks.data.type` | string | | Must be `"stacks"`. Only available in HCP Terraform. |
687+
| `data.relationships.allowed-stacks.data.id` | string | | The ID of the Stack that has permission to use the agent pool. Only available in HCP Terraform, refer to [Scope agent pools](/terraform/cloud-docs/agents#scope-an-agent-pool) to learn more. |
688688
| `data.relationships.allowed-projects.data.type` | string | | Must be `"projects"`. Refer to [Scoping Agent Pools to Specific Projects](/terraform/cloud-docs/agents#scope-an-agent-pool-to-specific-projects). |
689689
| `data.relationships.allowed-projects.data.id` | string | | The ID of the project that has permission to use the agent pool. |
690690
| `data.relationships.excluded-workspaces.data.type` | string | | Must be `"workspaces"`. |
691691
| `data.relationships.excluded-workspaces.data.id` | string | | The ID of the workspace that is excluded from the scope of the agent pool. |
692-
| `data.relationships.excluded-stacks.data.type` | string | | Must be `"stacks"`. |
693-
| `data.relationships.excluded-stacks.data.id` | string | | The ID of the stack that is excluded from the scope of the agent pool. |
692+
| `data.relationships.excluded-stacks.data.type` | string | | Must be `"stacks"`. Only available in HCP Terraform. |
693+
| `data.relationships.excluded-stacks.data.id` | string | | The ID of the Stack that is excluded from the scope of the agent pool. Only available in HCP Terraform. |
694694

695695
### Sample Payload
696696

@@ -870,4 +870,4 @@ The GET endpoints above can optionally return related resources, if requested wi
870870
| Resource Name | Description |
871871
| -------------- | ------------------------------------------- |
872872
| `workspaces` | The workspaces attached to this agent pool. |
873-
| `stacks` | The stacks attached to this agent pool. |
873+
| `stacks` | The Stacks attached to this agent pool. Only available in HCP Terraform. |

0 commit comments

Comments
 (0)