Skip to content

Commit d130d1d

Browse files
committed
filter projects by tag API parameter
1 parent a09f078 commit d130d1d

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ description: >-
99

1010
Keep track of changes to the API for HCP Terraform and Terraform Enterprise.
1111

12+
## 2025-10-31
13+
* Document API filtering parameters when [`listing projects`](/terraform/cloud-docs/api-docs/projects)
14+
1215
<!-- BEGIN: TFC:only name:hcp-eu -->
1316

1417
## 2025-9-30

content/terraform-docs-common/docs/cloud-docs/api-docs/projects.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,8 @@ This endpoint supports pagination [with standard URL query parameters](/terrafor
334334
| `filter[permissions][create-workspace]` | **Optional.** If present, returns a list of projects that the authenticated user can create workspaces in. |
335335
| `filter[permissions][move-stack]` | **Optional.** If present, returns a list of projects that the authenticated user can move Stacks between. Only available in HCP Terraform. |
336336
| `filter[permissions][update]` | **Optional.** If present, returns a list of projects that the authenticated user can update. |
337+
| `filter[tagged][i][key]` | **Optional.** If specified, restricts results to projects that are tagged with the provided key. Use a value of "0" for `i` if you are only using a single filter. For multiple tag filters, use an incrementing integer value for each filter. Multiple tag filters will be combined together with a logical AND when filtering results. |
338+
| `filter[tagged][i][value]` | **Optional.** If specified, restricts results to projects that are tagged with the provided value. This is useful when combined with a `key` filter for more specificity. Use a value of "0" for `i` if you are only using a single filter. For multiple tag filters, use an incrementing integer value for each filter. Multiple tag filters will be combined together with a logical AND when filtering results. |
337339
| `sort` | **Optional.** Allows sorting the organization's projects by `"name"`. Prepending a hyphen to the sort parameter reverses the order. For example, `"-name"` sorts by name in reverse alphabetical order. If omitted, the default sort order is arbitrary but stable. |
338340

339341
### Sample Request

0 commit comments

Comments
 (0)