Finally get to the changes from last TFE release (#470)

rkoron007 · web-flow · commit 9d76b7b7029e · 2025-06-06T12:56:29.000-07:00
diff --git a/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx b/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx
@@ -11,22 +11,25 @@ Keep track of changes to the API for HCP Terraform and Terraform Enterprise.
 
 ## 2025-05-1
 * Add `agent-pool` relationship to the [run task API](/terraform/cloud-docs/api-docs/run-tasks/run-tasks), which you can use to assign a run task to an agent pool.
+<!-- BEGIN: TFC:only name:premium -->
 * Add `private-run-tasks` to [feature entitlements](/terraform/cloud-docs/api-docs#feature-entitlements).
-<!-- BEGIN: TFC:only name:revoke -->
+<!-- END: TFC:only name:premium -->
 * You can now revoke, and revert the revocation of, module versions. Learn more about [Managing module versions](/terraform/cloud-docs/api-docs/private-registry/manage-module-versions).
-<!-- END: TFC:only name:revoke -->
+
 ## 2025-4-17
 * Document inherited-from link associated with effective tag bindings.
 
 ## 2025-03-20
-* Add API documentation for multiple [team tokens](/terraform/cloud-docs/api-docs/api-tokens), and update documentation around [legacy team tokens](/terraform/cloud-docs/api-docs/team-tokens##legacy-team-tokens-api-reference).
+* Add API documentation for multiple [team tokens](/terraform/cloud-docs/users-teams-organizations/api-tokens#team-api-tokens), and update documentation around [legacy team tokens](/terraform/cloud-docs/api-docs/team-tokens##legacy-team-tokens-api-reference).
 * Update existing API documentation for [team tokens](/terraform/cloud-docs/api-docs/team-tokens) to distinguish multiple team tokens from [legacy team tokens](/terraform/cloud-docs/api-docs/team-tokens##legacy-team-tokens-api-reference).
 
 ## 2025-3-10
 * Document unique pagination metadata given in the response of [Organization Runs Index API](/terraform/cloud-docs/api-docs/run##list-runs-in-an-organization).
 
+<!-- BEGIN: TFC:only name:explorer -->
 ## 2025-03-10
 * Add new field `current_rum_count` to the [explorer API](/terraform/cloud-docs/api-docs/explorer) in the `workspaces` view type that lists a workspace's current resources under management.
+<!-- END: TFC:only name:explorer -->
 
 ## 2024-11-19
 
@@ -230,7 +233,7 @@ This endpoint is exclusive to Terraform Enterprise, and not available in HCP Ter
 
 ## 2023-04-25
 
-* Add the `version-id` property to the response for the Create, List, and Update [Workspace Variables endpoints](/terraform/cloud-docs/api-docs/workspaces-variables).
+* Add the `version-id` property to the response for the Create, List, and Update [Workspace Variables endpoints](terraform/cloud-docs/api-docs/variables).
 
 ## 2023-03-30
 
@@ -318,12 +321,12 @@ This endpoint is exclusive to Terraform Enterprise, and not available in HCP Ter
 ### 2022-07-26
 
 * Updated the [Run status list](/terraform/cloud-docs/api-docs/run#run-states) with `fetching`, `queuing`, `pre_plan_running` and `pre_plan_completed`
-* Update [Run Tasks](/terraform/cloud-docs/api-docs/run-tasks.mdx) to include the new `stages` attribute when attaching or updating workspace tasks.
+* Update [Run Tasks](/terraform/cloud-docs/api-docs/run-tasks/run-tasks) to include the new `stages` attribute when attaching or updating workspace tasks.
 * Updated [Run Tasks Integration](/terraform/cloud-docs/api-docs/run-tasks/run-tasks-integration) to specify the different request payloads for different stages.
 
 ### 2022-06-23
 <!-- BEGIN: TFC:only name:health-assessments -->
-* Added the [Assessments](/terraform/cloud-docs/api-docs/assessments).
+* Added the [Assessments](/terraform/cloud-docs/api-docs/assessment-results).
 * Updated [Workspace](/terraform/cloud-docs/api-docs/workspaces#create-a-workspace) and
 [Notification Configurations](/terraform/cloud-docs/api-docs/notification-configurations#notification-triggers) to account for assessments.
 <!-- END: TFC:only name:health-assessments -->
@@ -340,7 +343,7 @@ This endpoint is exclusive to Terraform Enterprise, and not available in HCP Ter
 
 ### 2022-06-17
 * Updated [Creating a Run Task](/terraform/cloud-docs/workspaces/settings/run-tasks#creating-a-run-task) section to include the new description information for the run task to be configured.
-* Update [Run Tasks](/terraform/cloud-docs/api-docs/run-tasks.mdx) to include the new description attribute.
+* Update [Run Tasks](/terraform/cloud-docs/api-docs/run-tasks/run-tasks) to include the new description attribute.
 
 ### 2022-06-09
 
diff --git a/content/terraform-docs-common/docs/cloud-docs/api-docs/index.mdx b/content/terraform-docs-common/docs/cloud-docs/api-docs/index.mdx
@@ -94,8 +94,10 @@ The following entitlements are available:
 - `policy-enforcement` — Allows an organization to use [Sentinel][]. Affects the [policies][], [policy sets][], and [policy checks][] endpoints.
 - `private-module-registry` — Allows an organization to publish and use modules with the [private module registry][]. Affects the [registry modules][] endpoints.
 - `private-policy-agents` - Allows an organization to ensure that HTTP enabled [Sentinel][] and OPA [policies][] can communicate with isolated, private, or on-premises infrastructure.
+<!-- BEGIN: TFC:only name:premium -->
 - `private-run-tasks` - Allows an organization to ensure that [run tasks](/terraform/cloud-docs/workspaces/settings/run-tasks) can communicate with isolated, private, or on-premises infrastructure.
 - `private-vcs` - Allows a self-hosted HCP Terraform agent to [connect to a private VCS provider](/terraform/cloud-docs/vcs/private) without having to expose that provider to the public internet.
+<!-- END: TFC:only name:premium -->
 - `run-tasks` — Allows an organization to use [run tasks](/terraform/cloud-docs/workspaces/settings/run-tasks). Affects the [run tasks][] endpoints.
 - `self-serve-billing` — Allows an organization to pay via credit card using the in-app billing UI.
 - `sentinel` -  **DEPRECATED** Use `policy-enforcement` instead.
@@ -337,7 +339,7 @@ $ curl \
 
 ## Rate Limiting
 
-You can make up to 30 requests per second to most API endpoints as an authenticated or unauthenticated request. If you reach the rate limit then your access will be throttled and an error response will be returned. 
+You can make up to 30 requests per second to most API endpoints as an authenticated or unauthenticated request. If you reach the rate limit then your access will be throttled and an error response will be returned.
 
 Requests are per user, not per token. As a result, you cannot use multiple tokens to make more than 30 requests per second.
 
diff --git a/content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/manage-module-versions.mdx b/content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/manage-module-versions.mdx
@@ -40,26 +40,18 @@ description: |-
 
 Use the module version management API endpoints to deprecate, revoke, and revert of status of module versions in your organization’s private registry.
 
-<>{/* TODO: remove revoke references here */}</>
-
 <!-- BEGIN: TFC:only name:pnp-callout -->
 @include "tfc-package-callouts/manage-module-versions.mdx"
 <!-- END: TFC:only name:pnp-callout -->
 
 ## Overview
 
-<>{/* TODO: remove revoke references here */}</>
-
 As part of the module lifecycle, you can deprecate or revoke older module versions as you stop supporting them, signaling to module consumers that they need to upgrade to newer versions.
 
 When you deprecate a module version, HCP Terraform adds warnings to the module's registry page and to run outputs when anyone uses the deprecated version. After deprecating a module version, you can revert that deprecated status to remove the warnings from that version in the registry and outputs.
 
-<!-- BEGIN: TFC:only name:revoke -->
-
 Revoking a module version adds warnings to the module's registry page, warnings in the run outputs of existing users, and blocks new users from using that version. Reverting a module version’s revocation sets the module version back to a deprecated state.
 
-<!-- END: TFC:only name:revoke -->
-
 For more details on deprecating or revoking module versions, refer to [Manage module versions](/terraform/cloud-docs/registry/manage-module-versions).
 
 ## Deprecate a module version
@@ -80,7 +72,7 @@ This endpoint allows you to deprecate a specific module version. Deprecating a m
 
 | Status | Response | Reason |
 | :---- | :---- | :---- |
-| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](http://terraform/cloud-docs/api-docs#json-api-documents)  | Successfully deprecated a module version.  |
+| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](/terraform/cloud-docs/api-docs#json-api-documents)  | Successfully deprecated a module version.  |
 | [404](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404) | [JSON API error object](http://jsonapi.org/format/#error-objects) | This organization is not authorized to deprecate this module version, or the module version does not exist. |
 | [422](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422) | [JSON API error object](http://jsonapi.org/format/#error-objects) | Malformed request body, for example the request is missing attributes or uses the wrong types. |
 | [500](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) or [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) | [JSON API error object](http://jsonapi.org/format/#error-objects) | Failure occurred while deprecating a module version. |
@@ -160,7 +152,7 @@ Deprecating a module version adds warnings to the run output of any consumers us
 
 | Status | Response | Reason |
 | :---- | :---- | :---- |
-| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](http:///terraform/cloud-docs/api-docs#json-api-documents)  | Successfully reverted a module version’s deprecation status and reinstated that version. |
+| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](/terraform/cloud-docs/api-docs#json-api-documents)  | Successfully reverted a module version’s deprecation status and reinstated that version. |
 | [404](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404) | [JSON API error object](http://jsonapi.org/format/#error-objects) | This organization is not authorized to revert the depreciation of this module version, or the module version does not exist. |
 | [422](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422) | [JSON API error object](http://jsonapi.org/format/#error-objects) | Malformed request body, for example the request is missing attributes or uses the wrong types. |
 | [500](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) or [503] | [JSON API error object](http://jsonapi.org/format/#error-objects) | Failure occurred while reverting the deprecation of a module version. |
@@ -281,8 +273,6 @@ The response includes multiple versions, and each version has a `deprecation` ke
 }
 ```
 
-<!-- BEGIN: TFC:only name:revoke -->
-
 ## Revoke a module version
 
 Use this endpoint to revoke a module version. You must [deprecate a module version](#deprecate-a-module-version) before you can revoke it.
@@ -300,7 +290,7 @@ This endpoint allows you to revoke a specific module version. Revoking a module
 
 | Status | Response | Reason |
 | :---- | :---- | :---- |
-| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](http://terraform/cloud-docs/api-docs#json-api-documents)  | Successfully revoked a module version.  |
+| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](/terraform/cloud-docs/api-docs#json-api-documents)  | Successfully revoked a module version.  |
 | [404](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404) | [JSON API error object](http://jsonapi.org/format/#error-objects) | This organization is not authorized to revoke this module version, or the module version does not exist. |
 | [422](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422) | [JSON API error object](http://jsonapi.org/format/#error-objects) | Malformed request body, for example the request is missing attributes or uses the wrong types. |
 | [500](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) or [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) | [JSON API error object](http://jsonapi.org/format/#error-objects) | Failure occurred while revoking a module version. |
@@ -386,7 +376,7 @@ When you revert the revocation of a module version, HCP Terraform sets that vers
 
 | Status | Response | Reason |
 | :---- | :---- | :---- |
-| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](http:///terraform/cloud-docs/api-docs#json-api-documents)  | Successfully reverted a module version’s revocation status and deprecated that version. |
+| [200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) | [JSON API document](/terraform/cloud-docs/api-docs#json-api-documents)  | Successfully reverted a module version’s revocation status and deprecated that version. |
 | [404](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404) | [JSON API error object](http://jsonapi.org/format/#error-objects) | This organization is not authorized to revert the revocation of this module version, or the module version does not exist. |
 | [422](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422) | [JSON API error object](http://jsonapi.org/format/#error-objects) | Malformed request body, for example the request is missing attributes or uses the wrong types. |
 | [500](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) or [503] | [JSON API error object](http://jsonapi.org/format/#error-objects) | Failure occurred while reverting the revocation of a module version. |
@@ -525,5 +515,3 @@ The response includes the revoked versions of this module in the `revoked-versio
   },
 }
 ```
-
-<!-- END: TFC:only name:revoke -->
diff --git a/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks-integration.mdx b/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks-integration.mdx
@@ -27,7 +27,12 @@ Refer to [run tasks](/terraform/cloud-docs/api-docs/run-tasks/run-tasks) for the
 
 When a run reaches the appropriate phase and a run task is triggered, HCP Terraform will send a request to the run task's URL.
 
+<!-- BEGIN: TFC:only name:premium -->
+
 Either HCP Terraform itself, or a self-hosted HCP Terraform agent using [request forwarding](/terraform/cloud-docs/agents/request-forwarding) can make the request to a run task's URL. Your organization [must be entitled to `private-run-tasks`](/terraform/cloud-docs/api-docs#feature-entitlements) to use request forwarding.
+
+<!-- END: TFC:only name:premium -->
+
 The service receiving the run task request should respond with `200 OK`, or HCP Terraform will retry to trigger the run task.
 
 `POST :url`
diff --git a/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx b/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx
@@ -88,7 +88,7 @@ Properties without a default value are required unless otherwise specified.
 | `data.attributes.global-configuration.enabled`           | bool   | false   | (Optional) Whether the task will be associated on all workspaces.                                                                                                                                 |
 | `data.attributes.global-configuration.stages`            | array  |         | (Optional) An array of strings representing the stages of the run lifecycle when the run task should begin. Must be one or more of `"pre_plan"`, `"post_plan"`, `"pre_apply"`, or `"post_apply"`. |
 | `data.attributes.global-configuration.enforcement-level` | string |         | (Optional) The enforcement level of the workspace task. Must be `"advisory"` or `"mandatory"`.                                                                                                    |
-| `data.relationships.agent-pool.data.id`                  | string |         | (Optional) The agent pool that HCP Terraform uses to make requests for the run task. Requires the [`private_run_tasks` feature entitlement](/terraform/cloud-docs/api-docs#feature-entitlements) and a self-hosted HCP Terraform agent with [request forwarding](/terraform/cloud-docs/agents/request-forwarding).                                                                    |
+| `data.relationships.agent-pool.data.id`                  | string |         | (Optional) The agent pool that HCP Terraform uses to make requests for the run task. Requires [HCP Terraform Premium plan](https://www.hashicorp.com/en/pricing?tab=terraform), the [`private_run_tasks` feature entitlement](/terraform/cloud-docs/api-docs#feature-entitlements), and a self-hosted HCP Terraform agent with [request forwarding](/terraform/cloud-docs/agents/request-forwarding). |
 
 ### Sample Payload
 
diff --git a/content/terraform-docs-common/docs/cloud-docs/integrations/kubernetes/setup.mdx b/content/terraform-docs-common/docs/cloud-docs/integrations/kubernetes/setup.mdx
@@ -6,13 +6,13 @@ description: >-
 
 # Set up the HCP Terraform Operator for Kubernetes
 
-The HCP Terraform Operator for Kubernetes' CustomResourceDefinitions (CRD) allow you to dynamically create HCP Terraform workspaces with Terraform modules, populate workspace variables, and provision infrastructure with Terraform runs. 
+The HCP Terraform Operator for Kubernetes' CustomResourceDefinitions (CRD) allow you to dynamically create HCP Terraform workspaces with Terraform modules, populate workspace variables, and provision infrastructure with Terraform runs.
 
 You can install the operator with the official [HashiCorp Helm chart](https://github.com/hashicorp/hcp-terraform-operator).
 
 ## Prerequisites
 
-All HCP Terraform users can use the HCP Terraform Operator for Kubernetes. You can use the operator to manage the supported features that your organization's pricing tier enables. 
+All HCP Terraform users can use the HCP Terraform Operator for Kubernetes. You can use the operator to manage the supported features that your organization's pricing tier enables.
 
 
 ## Networking requirements
@@ -72,7 +72,7 @@ The HCP Terraform Operator for Kubernetes supports the following versions:
 
       ```shell-session
       $ helm install --namespace ${RELEASE_NAMESPACE} hashicorp/hcp-terraform-operator tfc-operator
-      ``` 
+      ```
    When deploying in self-managed Terraform Enterprise, you must set the `operator.tfeAddress` to the specific hostname of the Terraform Enterprise instance:
 
       ```shell-session
@@ -99,6 +99,6 @@ The HCP Terraform Operator for Kubernetes supports the following versions:
 
 When a new version of the HCP Terraform Operator for Kubernetes Helm Chart is available from the HashiCorp Helm repository, you can upgrade with the following command.
 
-```
+```shell-session
 helm upgrade --namespace ${RELEASE_NAMESPACE} hashicorp/hcp-terraform-operator tfc-operator
 ```
diff --git a/content/terraform-docs-common/docs/cloud-docs/registry/index.mdx b/content/terraform-docs-common/docs/cloud-docs/registry/index.mdx
@@ -13,7 +13,9 @@ HCP Terraform's private registry works similarly to the [public Terraform Regist
 
 [Public modules and providers](/terraform/cloud-docs/registry/add) are hosted on the public Terraform Registry and HCP Terraform can automatically synchronize them to an organization's private registry. This lets you clearly designate which public providers and modules are recommended for the organization and makes their supporting documentation and examples centrally accessible.
 
+<!-- BEGIN: TFC:only name:namespaces -->
 For more information about publishing artifacts to the public registry with an HCP Terraform organization, refer to [Namespaces](/terraform/cloud-docs/public-namespace).
+<!-- END: TFC:only name:namespaces -->
 
 -> **Note:** Your Terraform Enterprise instance must allow access to `registry.terraform.io`, `https://yy0ffni7mf-dsn.algolia.net/` and `github.com`.
 
diff --git a/content/terraform-docs-common/docs/cloud-docs/registry/manage-module-versions.mdx b/content/terraform-docs-common/docs/cloud-docs/registry/manage-module-versions.mdx
diff --git a/content/terraform-docs-common/docs/cloud-docs/users-teams-organizations/api-tokens.mdx b/content/terraform-docs-common/docs/cloud-docs/users-teams-organizations/api-tokens.mdx
diff --git a/content/terraform-docs-common/docs/cloud-docs/vcs/index.mdx b/content/terraform-docs-common/docs/cloud-docs/vcs/index.mdx
