Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/_template.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
page_title: /example-endpoint API reference for HCP Terraform
description: Use the HCP Terraform API's `/endpoint-name` to {A meaningful description of this endpoint}. Aim for 130-160 characters total.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

Follow this template to format each API method. There are usually multiple sections like this on a given API endpoint page.

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/account.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ page_title: /account API reference for HCP Terraform
description: >-
Use the HCP Terraform API's `/account` endpoint to manage the current user. Learn how to read and update your account's details and change your password.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/agent-tokens.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ page_title: /authentication-tokens API reference for HCP Terraform
description: >-
Use the HCP Terraform API's `/authentication-tokens` endpoint to manage agent tokens. Learn how to read, create, and destroy agent tokens.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/agents.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ page_title: /agents and /agent-pools API reference for HCP Terraform
description: >-
Use the HCP Terraform API's `/agents` endpoint to read and delete agents. Use the `/agent-pools` endpoint to read, create, update, and delete agent pools.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/applies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ page_title: /applies API reference for HCP Terraform
description: >-
Use the HCP Terraform API's `/applies` endpoint to read the results of a Terraform apply and to recover any failed state uploads after applying.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/assessment-results.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ page_title: /assessment-results API reference for HCP Terraform
description: >-
Use the HCP Terraform API's `/assessment-results` endpoint to read a health assessment's results, including details on continuous validation and drift detection.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/audit-trails-tokens.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ description: >-
Use the `/authentication-token` endpoint with the `token` query parameter to manage audit trails API tokens. Generate and delete audit trail tokens using the API.
tfc_only: true
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/audit-trails.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ description: >-
Use the HCP Terraform API's `/organization/audit-trail` endpoint to read a list of an organization's audit events for the past 14 days.
tfc_only: true
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/change-requests.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ description: >-
Use the `/change_requests` endpoint to view and archive change requests on given workspace.
tfc_only: true
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ page_id: api-changelog
description: >-
Use this log of HCP Terraform API changes to track new features and evolving functionality over time.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

# API Changelog

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/comments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ page_title: /comments API reference for HCP Terraform
description: >-
Use the HCP Terraform API's `/comments` endpoint to create and read comments on Terraform runs.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/configuration-versions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ page_title: /configuration-versions API reference for HCP Terraform
description: >-
Use the HCP Terraform API's `/configuration-versions` endpoint to list, show, and create a configuration version and its files within a workspace.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/cost-estimates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ page_title: /cost-estimates API reference for HCP Terraform
description: >-
Use the HCP Terraform API's `/cost-estimates` endpoint to read a cost estimate using its ID.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/explorer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ description: >-
Use the HCP Terraform API's `/explorer` endpoint to query, filter, save, and sort data about resources, modules, and providers across your workspaces and projects.
tfc_only: true
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/feature-sets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ tfc_only: true
description: >-
Use the HCP Terraform API's `/feature-sets` endpoint to read all available feature sets, and which feature sets your organization can access.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/github-app-installations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ page_title: /github-app/installations API reference for HCP Terraform
description: >-
Use the HCP Terraform API's `/github-app/installations` endpoint to view details about where you have installed the Terraform Cloud GitHub App.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ page_title: API documentation for HCP Terraform
description: >-
Learn about API authentication, response codes, versioning, formatting, rate limiting, and clients.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/invoices.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ description: >-
Use HCP Terraform API's `/invoices` endpoint to read an organization's current and past invoices, and fetch your organization's next upcoming invoice.
tfc_only: true
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/ip-ranges.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ tfc_only: true
description: >-
Use the HCP Terraform API's `/meta/ip-ranges` endpoint to read a list of the IP ranges that HCP Terraform uses.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/no-code-provisioning.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ page_title: /no-code-modules API reference for HCP Terraform
description: >-
Use the HCP Terraform API's `/no-code-modules` endpoint to designate and configure no-code modules. You can also use this endpoint to deploy and upgrade no-code workspaces.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ page_title: /notification-configurations API reference for HCP Terraform
description: >-
Use the HCP Terraform API's `/notification-configurations` endpoint to read, create, update, verify, and delete workspace configurations and create team configurations.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/oauth-clients.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ page_title: /oauth-clients API reference for HCP Terraform
description: >-
Use the HCP Terraform API's `/oauth-clients` endpoint to manage connections between VCS providers and organizations and projects. Learn how to read, create, update, and destroy clients.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
4 changes: 4 additions & 0 deletions website/docs/cloud-docs/api-docs/oauth-tokens.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ page_title: /oauth-tokens API reference for HCP Terraform
description: >-
Use the HCP Terraform API's `/oauth-tokens` endpoint to manage the OAuth tokens that connect workspaces to VCS providers. Learn how to read, update, and destroy tokens.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200

Expand Down
Loading