Skip to content

Add docs for explorer workspace tags [TF-30537] #957

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

Merged
merged 1 commit into from
Sep 19, 2025
Merged

Add docs for explorer workspace tags [TF-30537] #957

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
13 changes: 12 additions & 1 deletion content/terraform-docs-common/docs/cloud-docs/api-docs/explorer.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ fields available for each view type are detailed below:
| `resources_drifted` | `number` | The count of resources that drift was detected for. |
| `resources_undrifted` | `number` | The count of resources that drift was not detected for. |
| `state_version_terraform_version` | `string` | The Terraform version used to create the current run's state file. |
| `tags` | `string` | A comma separated list of tags (keys and key:value pairs) applied to this workspace. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `tags` | `string` | A comma separated list of tags (keys and key:value pairs) applied to this workspace. |
| `tags` | `string` | A comma separated list of tags, which are keys and `key:value` pairs, that are applied to this workspace. |

| `vcs_repo_identifier` | `string` | The name of the repository configured for this workspace, if available. |
| `workspace_created_at` | `datetime` | The time this workspace was created. |
| `workspace_name` | `string` | The name of this workspace. |
Expand Down Expand Up @@ -265,7 +266,15 @@ _Show data for all workspaces with `test` in their name_
```shell
curl \
--header "Authorization: Bearer $TOKEN" \
'https://app.terraform.io/api/v2/organizations/$ORG_NAME/explorer?type=workspaces&&filter%5B0%5D%5Bworkspace_name%5D%5Bcontains%5D%5B0%5D=test'
'https://app.terraform.io/api/v2/organizations/$ORG_NAME/explorer?type=workspaces&filter%5B0%5D%5Bworkspace_name%5D%5Bcontains%5D%5B0%5D=test'
```

_Show data for all workspaces with the tag key `billing` having value `tier2`_

```shell
curl \
--header "Authorization: Bearer $TOKEN" \
'https://app.terraform.io/api/v2/organizations/$ORG_NAME/explorer?type=workspaces&filter%5B0%5D%5Btags%5D%5Bcontains%5D%5B0%5D=billing:tier2'
```

**View Type: `modules`**
Expand Down Expand Up @@ -352,6 +361,7 @@ _Show data for all workspaces_
"resources-drifted": 0,
"resources-undrifted": 0,
"state-version-terraform-version": "1.5.7",
"tags": "",
"vcs-repo-identifier": null,
"workspace-created-at": "2023-10-17T21:56:45.570+00:00",
"workspace-name": "payments-service",
Expand Down Expand Up @@ -384,6 +394,7 @@ _Show data for all workspaces_
"resources-drifted": 3,
"resources-undrifted": 3,
"state-version-terraform-version": "1.4.5",
"tags": "billing:tier1, project_customer",
"vcs-repo-identifier": "acmecorp/api",
"workspace-created-at": "2023-04-25T17:09:14.960+00:00",
"workspace-name": "api-service",
Expand Down
Loading