add endpoint to list all workspace variables #1511
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Vercel Previews Deployed
|
Contributor
Broken Link CheckerNo broken links found! 🎉 |
debrin-hc
reviewed
Dec 16, 2025
Comment on lines
+205
to
+210
| When multiple variables share the same key and category, HCP Terraform applies the following precedence order (highest to lowest): | ||
|
|
||
| 1. Variables defined directly on the workspace | ||
| 2. Variables from variable sets scoped to the workspace | ||
| 3. Variables from variable sets scoped to the workspace's project | ||
| 4. Variables from global variable sets |
There was a problem hiding this comment.
- The precedence rules for variables aren't exactly this simple. There's global scopes and other nuances to the precedence order. The precedence order is already available on the public docs, so maybe we can skip it here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Added documentation for the
/workspaces/:workspace_id/all-varsAPI endpoint in the Workspace Variables API reference page.Changed pages:
content/terraform-docs-common/docs/cloud-docs/api-docs/workspace-variables.mdxWhy
The
/all-varsendpoint was previously undocumented. This endpoint returns all variables accessible to a workspace, including variables defined directly on the workspace and variables inherited from variable sets (global and scoped). This is useful for users who need to see the complete variable configuration with precedence rules applied, as the endpoint automatically filters out overwritten variables and shows only the effective variables.Screenshots
Merge Checklist
If items do not apply to your changes, add (N/A) and mark them as complete.
Pull Request
Content
content/terraform-docs-common/redirects.jsoncfor moved, renamed, or deleted pages across all affected versions. Refer to Redirects for examples and guidance.Reviews