content large_stringlengths 3 20.5k | url large_stringlengths 53 192 ⌀ | branch large_stringclasses 4
values | source large_stringclasses 51
values | embeddings listlengths 384 384 | score float64 -0.21 0.65 |
|---|---|---|---|---|---|
| Must be `"registry-modules"`. Only available when the enterprise-testing feature is enabled. | | `data.relationships.excluded-modules.data.id` | string | | The ID of the registry module that the agent pool is excluded from processing tests for. Only available when the enterprise-testing feature is enabled. | ### Samp... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/agents.mdx | main | terraform | [
-0.046869270503520966,
0.04047524556517601,
-0.049939826130867004,
0.05020330473780632,
0.002330356976017356,
-0.04478156194090843,
-0.02894642762839794,
-0.0582176111638546,
0.006178004667162895,
-0.023992309346795082,
0.05484321713447571,
-0.052846528589725494,
0.016743844375014305,
0.08... | 0.037761 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/no-code-provisioning.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
### Sample Request ```shell curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request POST \ --data @payload.json \ https://app.terraform.io/api/v2/organizations/my-organization/no-code-modules ``` ### Sample Response ```json { "data": { "id": "nocode-9HE91XDNY3faePn... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/no-code-provisioning.mdx | main | terraform | [
-0.040156252682209015,
0.028018290176987648,
-0.013591067865490913,
0.0049933744594454765,
0.0032253190875053406,
-0.052226997911930084,
-0.07630176097154617,
-0.0704609602689743,
0.04743892326951027,
0.09427715837955475,
0.009012586437165737,
-0.09283937513828278,
-0.0007887007668614388,
... | 0.029209 |
"type": "variable-options", "attributes": { "variable-name": "Linux AMIs", "variable-type": "array", "options": [ "Xenial Xerus", "Trusty Tahr" ] } }, { "id": "ncvaropt-dZMfdh9KBcwFjyv2", "type": "variable-options", "attributes": { "variable-name": "region", "variable-type": "array", "options": [ "eu-north-1", "us-east... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/no-code-provisioning.mdx | main | terraform | [
0.031221099197864532,
0.09979099035263062,
-0.03386741131544113,
-0.024952510371804237,
-0.004481672775000334,
-0.027809247374534607,
0.01561108697205782,
-0.002708651125431061,
0.003291209228336811,
0.06389762461185455,
-0.007830356247723103,
-0.13906624913215637,
0.0057445610873401165,
0... | 0.039026 |
} ] } ``` ## Create a no-code module workspace This endpoint creates a workspace from a no-code module. `POST /no-code-modules/:id/workspaces` | Parameter | Description | | -------------------- | ------------------------------------------ | | `:id` | The ID of the no-code module to provision. | Each HCP Terraform organ... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/no-code-provisioning.mdx | main | terraform | [
-0.048713572323322296,
-0.021613048389554024,
-0.052898868918418884,
0.011241206899285316,
-0.040495824068784714,
-0.005051031708717346,
-0.04276798665523529,
-0.06684858351945877,
0.0004102753009647131,
0.0421723835170269,
0.007701788563281298,
-0.0917513445019722,
0.04930087924003601,
-0... | 0.054447 |
to a specific project. | | `data.relationships.project.data.type` | string | | Must be `"project"`. | | `data.relationships.vars.data[].type` | string | | Must be `"vars"`. | | `data.relationships.vars.data[].attributes.key` | string | | The name of the variable. | | `data.relationships.vars.data[].attributes.value` | ... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/no-code-provisioning.mdx | main | terraform | [
0.01226906105875969,
0.040051575750112534,
-0.025535576045513153,
0.023036707192659378,
-0.0298427976667881,
0.004428006708621979,
0.022771459072828293,
-0.07444579154253006,
0.008645921014249325,
0.022624868899583817,
0.010448403656482697,
-0.14133678376674652,
0.08468394726514816,
0.0077... | -0.071915 |
Use the [confirm and apply a workspace upgrade plan API](#confirm-and-apply-a-workspace-upgrade-plan) to complete the workspace upgrade. `POST /no-code-modules/:no\_code\_module\_id/workspaces/:id/upgrade` | Parameter | Description | | -------------------- | -------------------------------| | `:no\_code\_module\_id` | ... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/no-code-provisioning.mdx | main | terraform | [
-0.09345629066228867,
-0.016847660765051842,
-0.026729073375463486,
0.0297586340457201,
-0.018226591870188713,
-0.05470846965909004,
-0.04123184084892273,
-0.031215965747833252,
0.0003922314790543169,
0.007965724915266037,
0.017414463683962822,
-0.05581926926970482,
-0.004723688587546349,
... | -0.024252 |
provisioning settings. `POST /no-code-modules/:no\_code\_module\_id/workspaces/:workspace\_id/upgrade/:id` | Parameter | Description | | -------------------- | -------------------------------| | `:no\_code\_module\_id` | The ID of the no-code module. | | `:workspace\_id` | The ID of workspace. | | `:id` | The ID of upd... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/no-code-provisioning.mdx | main | terraform | [
-0.047363270074129105,
0.01419783290475607,
-0.0449540801346302,
0.010341839864850044,
0.00041750181117095053,
-0.06514513492584229,
-0.07171362638473511,
-0.058070167899131775,
0.028985915705561638,
0.1239788830280304,
0.02898346446454525,
-0.0729038342833519,
0.020331313833594322,
-0.033... | 0.020736 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/variables.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
lists variables for all workspaces where you have permission to read variables. ([More about permissions.](/terraform/cloud-docs/users-teams-organizations/permissions)) [permissions-citation]: #intentionally-unused---keep-for-maintainers ### Sample Request ```shell $ curl \ --header "Authorization: Bearer $TOKEN" \ --h... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/variables.mdx | main | terraform | [
0.017927449196577072,
0.08204977959394455,
0.0023871459998190403,
0.04897720366716385,
0.019716015085577965,
-0.04976760223507881,
0.024242637678980827,
-0.0798524022102356,
0.054437629878520966,
0.05866941437125206,
-0.0025917969178408384,
-0.08326403796672821,
-0.007506649009883404,
0.04... | -0.001515 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/oauth-clients.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
"type": "oauth-clients", "attributes": { "created-at": "2018-04-16T20:42:53.771Z", "callback-url": "https://app.terraform.io/auth/35936d44-842c-4ddd-b4d4-7c741383dc3a/callback", "connect-path": "/auth/35936d44-842c-4ddd-b4d4-7c741383dc3a?organization\_id=1", "service-provider": "github", "service-provider-display-name"... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/oauth-clients.mdx | main | terraform | [
-0.052061837166547775,
0.0087739247828722,
-0.05370697006583214,
0.007356739137321711,
-0.005705640185624361,
-0.06709369271993637,
-0.05515936017036438,
-0.06697338074445724,
0.08214970678091049,
0.10228807479143143,
-0.002299221698194742,
-0.037163738161325455,
0.059144988656044006,
0.02... | 0.001392 |
text of the SSH private key associated with your Bitbucket Data Center application link. | | `data.attributes.rsa-public-key` | string | | \*\*Required for Bitbucket Data Center in conjunction with the `secret`. Not used for any other providers.\*\* The text of the SSH public key associated with your Bitbucket Data Cen... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/oauth-clients.mdx | main | terraform | [
-0.027904268354177475,
0.03090037778019905,
-0.10470100492238998,
0.08336854726076126,
0.026674814522266388,
-0.031643930822610855,
0.005092035047709942,
-0.05068246275186539,
0.07490882277488708,
0.026081349700689316,
-0.015094473026692867,
-0.012180806137621403,
0.06561595946550369,
0.01... | -0.023587 |
or another type of client key for the VCS provider. | | `data.attributes.secret` | string | (previous value) | The OAuth client secret. For Bitbucket Data Center, this secret is the text of the SSH private key associated with your Bitbucket Data Center application link. | | `data.attributes.rsa-public-key` | string | (... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/oauth-clients.mdx | main | terraform | [
-0.06112886220216751,
0.010854077525436878,
-0.04666002094745636,
0.029606452211737633,
-0.0033629636745899916,
0.012686403468251228,
0.013732885010540485,
-0.033207036554813385,
0.08842713385820389,
0.0768396183848381,
0.0059256721287965775,
-0.029384508728981018,
0.08197594434022903,
-0.... | -0.048411 |
--header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request DELETE \ https://app.terraform.io/api/v2/oauth-clients/oc-XKFwG6ggfA9n7t1K ``` ## Attach to a project `POST /oauth-clients/:id/relationships/projects` | Parameter | Description | | --------- | -----------------------... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/oauth-clients.mdx | main | terraform | [
-0.04431520029902458,
0.10592593997716904,
-0.006221357733011246,
0.030251571908593178,
0.03910251706838608,
-0.05817817896604538,
-0.0038308058865368366,
-0.017032451927661896,
0.0937197208404541,
0.04639450088143349,
-0.01895042136311531,
-0.09440816938877106,
0.056037530303001404,
0.039... | 0.014345 |
Description | | -------------- | ---------------------------------------- | | `oauth\_tokens` | The OAuth tokens managed by this client | | `projects` | The projects scoped to this client | | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/oauth-clients.mdx | main | terraform | [
-0.04066934436559677,
0.0663999393582344,
0.003737060585990548,
0.016791652888059616,
0.04838171973824501,
-0.04436014965176582,
0.06129705533385277,
0.01816406473517418,
0.04760954901576042,
-0.07834962755441666,
-0.03908704221248627,
-0.007472370285540819,
0.08354949951171875,
0.00017199... | 0.039277 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/oauth-tokens.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
Properties without a default value are required. | Key path | Type | Default | Description | | ------------------------- | ------ | ------- | ------------------------- | | `data.type` | string | | Must be `"oauth-tokens"`. | | `data.attributes.ssh-key` | string | | \*\*Optional.\*\* The SSH key | ### Sample Payload ```... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/oauth-tokens.mdx | main | terraform | [
0.04572492092847824,
0.07950480282306671,
-0.019756773486733437,
0.026746045798063278,
-0.007528373971581459,
-0.022910933941602707,
-0.018105963245034218,
0.05497279390692711,
0.04771051183342934,
-0.024687429890036583,
-0.0014329623663797975,
-0.1062299832701683,
0.02166132815182209,
0.0... | -0.046501 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/agent-tokens.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
[500][] | [JSON API error object][] | Failure during Agent Token creation | ### Request Body This POST endpoint requires a JSON object with the following properties as a request payload. Properties without a default value are required. | Key path | Type | Default | Description | | ----------------------------- | ------... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/agent-tokens.mdx | main | terraform | [
-0.018497075885534286,
0.0612403005361557,
-0.028910713270306587,
0.007691494654864073,
-0.05176844075322151,
-0.03177759051322937,
-0.028275374323129654,
0.023451728746294975,
0.04495570808649063,
0.0025746070314198732,
-0.021762406453490257,
-0.09314054995775223,
0.01339267659932375,
0.0... | 0.046778 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/account.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
| [401][] | [JSON API error object][] | Unauthorized | | [422][] | [JSON API error object][] | Malformed request body (missing attributes, wrong types, etc.) | ### Request Body This PATCH endpoint requires a JSON object with the following properties as a request payload. | Key path | Type | Default | Description | | --... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/account.mdx | main | terraform | [
-0.0681079551577568,
0.03991144523024559,
-0.03987467661499977,
-0.005491114221513271,
-0.06630963832139969,
-0.0637875646352768,
-0.006438193377107382,
0.021097246557474136,
-0.03127048537135124,
0.03725487366318703,
0.0029600781854242086,
-0.06768210232257843,
0.04561472311615944,
0.0164... | -0.001426 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/github-app-installations.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
# VCS events API reference -> \*\*Note\*\*: The VCS Events API is still in beta as support is being added for additional VCS providers. Currently only GitLab.com connections established after December 2020 are supported. VCS (version control system) events describe changes within your organization for VCS-related actio... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/vcs-events.mdx | main | terraform | [
-0.035735953599214554,
0.02360043115913868,
0.01822294294834137,
0.017164485529065132,
0.03342166170477867,
-0.05483488366007805,
-0.008408159017562866,
-0.03966129943728447,
0.14580465853214264,
0.07071278989315033,
-0.05795877054333687,
-0.030502621084451675,
-0.006822471972554922,
-0.02... | 0.037746 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/group-member-roles.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
| ### Query Parameters This endpoint supports pagination [with standard URL query parameters](/terraform/cloud-docs/api-docs#query-parameters). Remember to percent-encode `[` as `%5B` and `]` as `%5D` if your tooling doesn't automatically encode URLs. | Parameter | Description | | --------------- | --------------------... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/group-member-roles.mdx | main | terraform | [
-0.020988523960113525,
0.08490979671478271,
0.04145219177007675,
0.009616111405193806,
-0.08794776350259781,
0.028641995042562485,
-0.07210508733987808,
-0.07182466238737106,
0.05727924406528473,
0.07317671179771423,
-0.05782374367117882,
-0.057522159069776535,
0.05541406571865082,
-0.0654... | -0.032122 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [307]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/comments.mdx | main | terraform | [
-0.026010459288954735,
-0.02275005355477333,
-0.026095468550920486,
-0.018418513238430023,
-0.02009897492825985,
-0.08436909317970276,
-0.05374377593398094,
-0.0791759043931961,
-0.0060250526294112206,
-0.03486490249633789,
0.03005075827240944,
0.05508139356970787,
0.0022271922789514065,
-... | 0.068675 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [307]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/plans.mdx | main | terraform | [
-0.026010459288954735,
-0.02275005355477333,
-0.026095468550920486,
-0.018418513238430023,
-0.02009897492825985,
-0.08436909317970276,
-0.05374377593398094,
-0.0791759043931961,
-0.0060250526294112206,
-0.03486490249633789,
0.03005075827240944,
0.05508139356970787,
0.0022271922789514065,
-... | 0.068675 |
should not be relied upon beyond the initial request. If you need repeat access, you should use this endpoint to generate a new URL each time. -> \*\*Note:\*\* This endpoint is available for plans using Terraform 0.12 and later. For Terraform Enterprise, this endpoint is available from v202005-1, and its stability was ... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/plans.mdx | main | terraform | [
-0.04246988892555237,
0.009303000755608082,
0.029232293367385864,
0.020786505192518234,
-0.03713805973529816,
-0.050370749086141586,
-0.05467784032225609,
-0.0335351787507534,
0.06749116629362106,
0.09548787772655487,
-0.06646288931369781,
-0.029693158343434334,
0.024199465289711952,
0.033... | 0.043697 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/index.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
pattern for secure access. Treat URLs retrieved from the blob storage service as secrets. Do not log them or share them with untrusted parties. ## Feature entitlements HCP Terraform is available at multiple pricing tiers, including free, which offer different feature sets. Each organization has a set of \_entitlements\... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/index.mdx | main | terraform | [
-0.03677217662334442,
0.05778411030769348,
-0.0004060545179527253,
-0.012878160923719406,
0.0007851633126847446,
0.02270059660077095,
-0.01141400821506977,
-0.06285020709037781,
0.019163774326443672,
0.04246488958597183,
-0.025776350870728493,
-0.10654446482658386,
0.0892062559723854,
0.00... | 0.075493 |
the organization. If blank, there is no limit. - `vcs-integrations` — Allows an organization to [connect with a VCS provider][vcs integrations] and link VCS repositories to workspaces. Affects the [OAuth Clients][o-clients], and [OAuth Tokens][o-tokens] endpoints, and determines whether the `data.attributes.vcs-repo` p... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/index.mdx | main | terraform | [
-0.008489107713103294,
-0.019244501367211342,
-0.009671738371253014,
0.02539888583123684,
0.005556287709623575,
-0.04195637255907059,
-0.04702265188097954,
-0.03342830389738083,
0.10315055400133133,
0.062290772795677185,
-0.025868836790323257,
-0.050956841558218,
0.056291479617357254,
-0.0... | 0.019064 |
code. Has no effect for environment variables. | | `data.attributes.sensitive` | bool | `false` | Whether the value is sensitive. If true then the variable is written once and not visible thereafter. | | `data.relationships.workspace.data.type` | string | | Must be `"workspaces"`. | | `data.relationships.workspace.data... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/index.mdx | main | terraform | [
-0.03833625465631485,
0.02082403004169464,
-0.019941000267863274,
0.08959756046533585,
-0.04974833503365517,
-0.04162582755088806,
-0.03259728476405144,
-0.001339942216873169,
0.06377457827329636,
-0.05132001265883446,
-0.006826300173997879,
-0.026460565626621246,
0.055604223161935806,
0.0... | 0.02005 |
some endpoints To prevent abuse, some endpoints have lower rate limits. The lower limits are unnoticeable under normal use. If you trigger a rate-limited response, you can see that limit in the `x-ratelimit-limit` header. The following endpoints have lower rate limits: | Method and endpoint | Purpose | Limit | | --- | ... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/index.mdx | main | terraform | [
-0.004934394732117653,
-0.039945002645254135,
-0.012820547446608543,
0.007769620977342129,
0.006957347504794598,
-0.04090256616473198,
-0.062109217047691345,
0.06625459343194962,
0.03925796225667,
0.006776482332497835,
0.09107212722301483,
-0.05795503780245781,
0.08036696910858154,
0.00073... | 0.075763 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policy-checks.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
Use the data in this hash at your own risk. `POST /policy-checks/:id/actions/override` | Parameter | Description | | --------- | --------------------------------------- | | `id` | The ID of the policy check to override. | ### Sample Request ```shell curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Typ... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policy-checks.mdx | main | terraform | [
-0.04424009099602699,
0.12109950929880142,
0.026579923927783966,
-0.030913887545466423,
0.028433972969651222,
-0.05498791113495827,
-0.00005014597627450712,
-0.028454914689064026,
0.03360581025481224,
0.12948785722255707,
-0.014955765567719936,
-0.06506728380918503,
0.018449360504746437,
-... | -0.005124 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/projects.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
| string | none | Specifies the tag value for each object in the list. | | `data.attributes.default-execution-mode` | boolean | `remote` | Specifies which [execution mode](/terraform/cloud-docs/workspaces/settings#execution-mode) to use by default. Valid values are `remote`, `local`, and `agent`. | | `data.attributes.d... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/projects.mdx | main | terraform | [
-0.003000193042680621,
0.04174269363284111,
0.014453587122261524,
0.046984944492578506,
-0.018880531191825867,
-0.0272704865783453,
0.0006353547796607018,
-0.09231927245855331,
0.0056314910762012005,
0.0683901384472847,
0.00708115566521883,
-0.0497932992875576,
0.03888970986008644,
-0.0092... | -0.026179 |
to bind to the project. Workspaces inherit the tags bound to their project. | | `data.relationships.tag-bindings.data.type` | string | none | Must be `tag-bindings` for each object in the list. | | `data.relationships.tag-bindings.data.attributes.key` | string | none | Specifies the tag key for each object in the list.... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/projects.mdx | main | terraform | [
-0.022887330502271652,
0.004654678516089916,
-0.014021317474544048,
0.03271086513996124,
-0.042825374752283096,
-0.023811228573322296,
0.006191652733832598,
-0.07295557856559753,
0.029837755486369133,
0.06758289039134979,
-0.013583123683929443,
-0.07260561734437943,
0.07600339502096176,
0.... | -0.040726 |
| `filter[permissions][update]` | \*\*Optional.\*\* If present, returns a list of projects that the authenticated user can update. | | `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 sing... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/projects.mdx | main | terraform | [
0.01084899716079235,
0.08903592824935913,
0.02000068873167038,
-0.0425596758723259,
0.029749367386102676,
-0.019260887056589127,
0.06445053964853287,
-0.11103588342666626,
-0.04345186799764633,
0.046319782733917236,
-0.020253736525774002,
-0.12784120440483093,
0.0930647924542427,
-0.004053... | -0.02412 |
of the project to delete | | Status | Response | Reason(s) | |---------|---------------------------|-------------------------------------------------------------------| | [204][] | No Content | Successfully deleted the project | | [403][] | [JSON API error object][] | Not authorized to perform a force delete on the pro... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/projects.mdx | main | terraform | [
-0.0567186065018177,
0.06009320914745331,
-0.0619012713432312,
-0.03893490508198738,
0.04718087986111641,
-0.05379859358072281,
-0.006109327077865601,
-0.03831290826201439,
0.08714281767606735,
0.05418255552649498,
0.0479787178337574,
-0.06238185614347458,
0.020783111453056335,
0.045233957... | 0.098373 |
"tb-97ce954636f93a6c", "type": "tag-bindings", "attributes": { "key": "bar", "value": "baz" } } ] } ``` ## Move workspaces into a project This endpoint allows you to move one or more workspaces into a project. You must have permission to move workspaces on the destination project as well as any source project(s). If yo... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/projects.mdx | main | terraform | [
-0.05857633054256439,
-0.05477200821042061,
-0.0639432817697525,
0.039080578833818436,
-0.016682498157024384,
0.0028880101162940264,
-0.007256736513227224,
-0.016403719782829285,
0.03241217881441116,
0.030137207359075546,
-0.019398914650082588,
-0.05391484126448631,
0.0360758975148201,
0.0... | -0.019053 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policies.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
array should consist of a single element. For Sentinel, if the path in the enforcement map does not match the Sentinel policy (`.sentinel`), then HCP Terraform uses the default `hard-mandatory` enforcement level. For OPA, the default enforcement level is `advisory`. | | `data.attributes.enforce[].path` | string | | \*\... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policies.mdx | main | terraform | [
0.028143364936113358,
0.06619729846715927,
0.03949856013059616,
-0.01548552792519331,
0.009159074164927006,
-0.0318707637488842,
0.03258470445871353,
-0.04859704151749611,
-0.061751145869493484,
0.05501649156212807,
0.0046353149227797985,
-0.06665683537721634,
0.056499335914850235,
-0.0017... | 0.01462 |
"mode": "soft-mandatory" } ], "policy-set-count": 1, "updated-at": "2018-09-11T18:21:21.784Z" }, "relationships": { "organization": { "data": { "id": "my-organization", "type": "organizations" } }, "policy-sets": { "data": [ { "id": "polset-3yVQZvHzf5j3WRJ1", "type": "policy-sets" } ] } }, "links": { "self": "/api/v2/p... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policies.mdx | main | terraform | [
-0.05553293600678444,
0.09331317991018295,
-0.010371178388595581,
0.025567518547177315,
0.02866450324654579,
-0.008809183724224567,
-0.007761472836136818,
-0.020820166915655136,
0.009836798533797264,
0.0306710097938776,
0.02025325782597065,
-0.029282933101058006,
0.022289516404271126,
0.05... | 0.045157 |
does not match the Sentinel policy (`.sentinel`), then HCP Terraform uses the default `hard-mandatory` enforcement level. For OPA, the default enforcement level is `advisory`. | | `data.attributes.enforce[].path` | string | | \*\*DEPRECATED\*\* For Sentinel, must be `.sentinel`, where `` has the same value as `data.att... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policies.mdx | main | terraform | [
-0.01567044109106064,
0.05052826553583145,
0.07525745779275894,
-0.014433881267905235,
0.021306486800312996,
-0.052676789462566376,
0.004352835472673178,
-0.030197549611330032,
-0.02896924503147602,
0.0688558891415596,
0.005736514925956726,
-0.07267460972070694,
0.0337551087141037,
0.03003... | -0.002573 |
perform action | ### Sample Request ```shell curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request DELETE \ https://app.terraform.io/api/v2/policies/pl-u3S5p2Uwk21keu1s ``` ## Available Related Resources The GET endpoints above can optionally return related resou... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policies.mdx | main | terraform | [
-0.04062870517373085,
0.06877191364765167,
0.03226441144943237,
0.016349824145436287,
0.030299371108412743,
-0.013410689309239388,
0.007842378690838814,
-0.08177125453948975,
0.032951414585113525,
0.054525263607501984,
-0.03658659756183624,
-0.08055666089057922,
0.06994315981864929,
-0.004... | 0.010525 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/explorer.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
fields. | | `providers` | Information about the Terraform providers in use across the target organization. Each row returned represents a Terraform provider in use. See [View Type: providers](#view-type-providers) for available fields. | | `modules` | Information about the Terraform modules in use across the target org... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/explorer.mdx | main | terraform | [
-0.0034246291033923626,
0.006862480193376541,
-0.03001198172569275,
0.07348287850618362,
0.02612236700952053,
-0.0007957694469951093,
0.00985080935060978,
-0.08920827507972717,
0.020902080461382866,
0.00590531574562192,
-0.008986212313175201,
-0.08687018603086472,
0.015555819496512413,
-0.... | 0.032488 |
`workspace\_count` | `number` | The number of workspaces using this terraform version. | | `workspaces` | `string` | A comma-separated list of workspaces using this terraform version. | #### View Type: `providers` | Field | Type | Description | | ------------------| -------- | ------------------------------------------... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/explorer.mdx | main | terraform | [
-0.04680582508444786,
-0.03493037074804306,
0.013710741885006428,
0.05366348847746849,
-0.01726754754781723,
-0.0036406153813004494,
0.035562124103307724,
-0.07473048567771912,
0.03568431735038757,
0.04212597757577896,
-0.010527164675295353,
-0.09242312610149384,
0.031919464468955994,
-0.0... | 0.034988 |
different from the filter value. | | `contains` | `string` | Filters data to rows where the field value contains the filter value as a sub-string. | | `does not contain` | `string` | Filters data to rows where the field value does not contain the filter value as a sub-string. | | `is\_empty` | `boolean`, `number`, `str... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/explorer.mdx | main | terraform | [
0.019543811678886414,
0.03911133110523224,
0.01558777317404747,
-0.01660824567079544,
-0.03237646818161011,
0.00446500675752759,
0.04540568217635155,
0.007782783824950457,
-0.014481527730822563,
-0.030505623668432236,
0.00019584610708989203,
-0.01631198450922966,
0.09109844267368317,
-0.05... | -0.055365 |
0, "checks-failed": 0, "checks-passed": 0, "checks-unknown": 0, "current-rum-count": 0, "current-run-applied-at": "2023-08-18T16:24:59.000+00:00", "current-run-external-id": "run-9MmJaoQTvDCh5wUa", "current-run-status": "applied", "drifted": true, "external-id": "ws-igUVNQSYVXRkhYuo", "module-count": 0, "modules": null... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/explorer.mdx | main | terraform | [
-0.04905835911631584,
-0.04594741389155388,
-0.057383641600608826,
0.01463701669126749,
0.08136186003684998,
-0.07031231373548508,
0.003800302743911743,
-0.065791554749012,
0.01135769858956337,
0.11123327165842056,
0.06454737484455109,
-0.1251005232334137,
0.0547344796359539,
-0.0126883871... | 0.083355 |
list of filters, fields, and sorting rules for the view. Refer to [Query parameters](#query-parameters) for full details. | | `data.query.filter` | array\[objects]| | A list of filters composed of fields, operators, and values. | | `data.query.filter.field` | string | | The field name to filter by. | | `data.query.filt... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/explorer.mdx | main | terraform | [
-0.0060423389077186584,
0.08340975642204285,
0.01508049201220274,
0.011931778863072395,
-0.0034548791591078043,
-0.02313997969031334,
0.023662766441702843,
-0.03149481490254402,
0.016498064622282982,
0.09591277688741684,
-0.015067672356963158,
-0.007655687630176544,
0.0001968159049283713,
... | -0.009027 |
curl \ --header "Authorization: Bearer $TOKEN" \ --request PATCH \ --data @payload.json \ 'https://app.terraform.io/api/v2/organizations/$ORG\_NAME/explorer/viewsi/$VIEW\_ID' ``` ### Sample response ```json { "data": { "id": "sq-P9Yn6Ad6EiVMz77s", "type": "explorer-saved-queries", "attributes": { "name": "my saved quer... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/explorer.mdx | main | terraform | [
-0.00838400050997734,
0.06934064626693726,
0.022445114329457283,
0.07492242753505707,
-0.03414486348628998,
-0.0341162271797657,
-0.0223808903247118,
-0.09599506855010986,
0.06529318541288376,
0.05576268583536148,
-0.007577668875455856,
-0.12755241990089417,
0.011443259194493294,
0.0148922... | 0.00339 |
Sample request ```shell curl \ --header "Authorization: Bearer $TOKEN" \ --request GET \ 'https://app.terraform.io/api/v2/organizations/$ORG\_NAME/explorer/views/$VIEW\_ID/csv` ``` ### Sample response ```csv all\_checks\_succeeded,checks\_errored,checks\_failed,checks\_passed,checks\_unknown,current\_run\_applied\_at,c... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/explorer.mdx | main | terraform | [
-0.01898537576198578,
0.05731384828686714,
-0.06307914108037949,
0.024175895377993584,
0.03644387796521187,
-0.07215405255556107,
-0.03267476707696915,
-0.05505840852856636,
0.06993846595287323,
0.12242121994495392,
-0.004599070176482201,
-0.13698731362819672,
0.03951355442404747,
-0.04140... | 0.060279 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [302]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/configuration-versions.mdx | main | terraform | [
-0.02195754460990429,
-0.020659523084759712,
-0.0290676299482584,
-0.014626014977693558,
-0.0197884701192379,
-0.08796516060829163,
-0.05588258430361748,
-0.07633461803197861,
-0.001209685462526977,
-0.03585217893123627,
0.02804061770439148,
0.05407903343439102,
-0.0020975309889763594,
-0.... | 0.063536 |
will return the first page. | | `page[size]` | \*\*Optional.\*\* If omitted, the endpoint will return 20 configuration versions per page. | ### Sample Request ```shell curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request GET \ https://app.terraform.io/api/v2/wor... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/configuration-versions.mdx | main | terraform | [
-0.04897003993391991,
0.11985411494970322,
0.020292978733778,
0.03914857283234596,
0.02849380113184452,
-0.04027793928980827,
-0.08946839720010757,
-0.055115535855293274,
0.051864080131053925,
0.07778512686491013,
0.01047230139374733,
-0.0704207792878151,
0.014298204332590103,
-0.041563019... | -0.063586 |
be used to create runs which are speculative, that is, can neither be confirmed nor applied. | | `data.attributes.provisional` | boolean | false | When true, this configuration version does not immediately become the workspace current configuration version. If the associated run is applied, it then becomes the current ... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/configuration-versions.mdx | main | terraform | [
-0.07544317096471786,
0.07568658888339996,
0.036826327443122864,
0.005269830580800772,
0.020602311939001083,
-0.05816005542874336,
-0.056920040398836136,
-0.05981244519352913,
0.03841916099190712,
0.05816873162984848,
0.013096942566335201,
-0.03848098963499069,
0.018628928810358047,
0.0035... | 0.006569 |
| Description | | --------------------------- | ------------------------------------------------------------------- | | `run\_id` | The ID of the run whose configuration version should be downloaded. | These endpoints generate a temporary URL to the location of the configuration version in a `.tar.gz` archive, and then... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/configuration-versions.mdx | main | terraform | [
-0.03672241047024727,
0.07728266716003418,
-0.038133732974529266,
0.02080308273434639,
0.10740640759468079,
-0.02085993066430092,
-0.05752755329012871,
0.008702653460204601,
-0.06800555437803268,
0.03639919310808182,
-0.01769035868346691,
0.06823690235614777,
0.03411291167140007,
-0.052570... | -0.070227 |
Response | Reason(s) | | ------- | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | [200][] | none | Terraform successfully initiated the restore process. | | [400][] | [JSON API error object][] ... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/configuration-versions.mdx | main | terraform | [
-0.10001353919506073,
0.03879188373684883,
0.050492316484451294,
-0.002129421103745699,
0.032182469964027405,
-0.04882536455988884,
-0.06647196412086487,
-0.050512608140707016,
0.026751726865768433,
0.06723518669605255,
0.024459829553961754,
-0.09378253668546677,
0.04317798465490341,
-0.00... | 0.031434 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/organization-tokens.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/subscriptions.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspace-resources.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
| `/workspaces/:workspace\_id` | Call this endpoint to [force delete a workspace](#force-delete-a-workspace), which deletes the workspace without first checking for managed resources.| | `DELETE` | `/organizations/:organization\_name/workspaces/:name` | Call this endpoint to [force delete a workspace](#force-delete-a-w... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx | main | terraform | [
-0.0496993362903595,
-0.016819780692458153,
-0.019284343346953392,
0.04202168062329292,
0.0462861992418766,
-0.06242205202579498,
0.022831177338957787,
-0.1542978733778,
0.04819649085402489,
0.09752321243286133,
-0.022458551451563835,
-0.0506848506629467,
0.04530438408255577,
0.07560034096... | 0.058896 |
example, to queue destroy runs after fourteen days of inactivity set `auto-destroy-activity-duration: "14d"`. | | `data.attributes.description` | string | (nothing) | A description for the workspace. | | `data.attributes.execution-mode` | string | (nothing) | Which [execution mode](/terraform/cloud-docs/workspaces/sett... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx | main | terraform | [
-0.01915539987385273,
0.00156175228767097,
0.04924852028489113,
0.05439490079879761,
-0.004924539476633072,
-0.026114676147699356,
0.018957218155264854,
-0.09526253491640091,
0.05089380964636803,
0.09012313932180405,
0.005807965062558651,
0.00007084258686518297,
0.005004756152629852,
-0.02... | 0.030307 |
repository. | | `data.attributes.trigger-prefixes` | array | `[]` | List of trigger prefixes that describe the paths HCP Terraform monitors for changes, in addition to the working directory. Trigger prefixes are always appended to the root directory of the repository. HCP Terraform starts a run when files are changed i... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx | main | terraform | [
0.02734472043812275,
-0.02995150163769722,
0.04065001755952835,
0.004153097048401833,
-0.010324227623641491,
-0.005102426279336214,
-0.0006096295546740294,
-0.06751538813114166,
0.06953898817300797,
0.11077231913805008,
0.014219984412193298,
-0.06783805042505264,
0.05481591820716858,
-0.03... | 0.032187 |
"name": "workspace-1" }, "type": "workspaces", "relationships": { "tag-bindings": { "data": [{ "type": "tag-bindings", "attributes": { "key": "env", "value": "test"} }] } } } } ``` \_With a VCS repository\_ ```json { "data": { "attributes": { "name": "workspace-2", "terraform\_version": "0.11.1", "working-directory": "... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx | main | terraform | [
-0.04914360120892525,
0.034913450479507446,
0.01612047664821148,
0.05591849982738495,
-0.01090156938880682,
-0.07817572355270386,
0.03797311708331108,
-0.016820400953292847,
0.06960342824459076,
0.04502960294485092,
0.015449409373104572,
-0.09438273310661316,
0.048019468784332275,
0.062239... | 0.0071 |
}, "description": null, "file-triggers-enabled": true, "trigger-prefixes": [], "trigger-patterns": [], "assessments-enabled": false, "last-assessment-result-at": null, "source": "tfe-api", "source-name": null, "source-url": null, "tag-names": [], "setting-overwrites": { "execution-mode": false, "agent-pool": false } },... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx | main | terraform | [
-0.030887208878993988,
0.07128996402025223,
-0.054798197001218796,
0.06539008021354675,
0.027523662894964218,
-0.016805170103907585,
-0.044318221509456635,
-0.006018337793648243,
-0.01433112658560276,
0.007123216986656189,
0.0343715064227581,
-0.07050435990095139,
0.030633753165602684,
0.0... | 0.104391 |
| | `data.attributes.description` | string | (previous value) | A description for the workspace. | | `data.attributes.execution-mode` | string | (previous value) | Which [execution mode](/terraform/cloud-docs/workspaces/settings#execution-mode) to use. Valid values are `remote`, `local`, and `agent`. When set to `local... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx | main | terraform | [
-0.015868697315454483,
-0.006109872367233038,
0.04984939098358154,
0.0590050034224987,
0.004892616532742977,
-0.006275729741901159,
0.0022563280072063208,
-0.07283037155866623,
0.035793203860521317,
0.07540351897478104,
0.024727003648877144,
-0.021656010299921036,
0.010023270733654499,
-0.... | -0.01295 |
to your VCS repository in the format :org/:repo where :org and :repo refer to the organization and repository in your VCS provider. The format for Azure DevOps is `:org/:project/\_git/:repo`. | | `data.attributes.vcs-repo.ingress-submodules` | boolean | (previous value) | Whether submodules should be fetched when cloni... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx | main | terraform | [
-0.007161751389503479,
-0.014011076651513577,
0.00506634684279561,
0.013774142600595951,
0.03669653832912445,
-0.006684767082333565,
0.033827345818281174,
-0.007098012138158083,
0.1425790637731552,
0.11059361696243286,
-0.023420073091983795,
-0.09419281035661697,
0.052344318479299545,
-0.0... | 0.014481 |
curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request PATCH \ --data @payload.json \ https://app.terraform.io/api/v2/organizations/my-organization/workspaces/workspace-2 ``` ### Sample Response @include 'api-code-blocks/workspace-with-vcs.mdx' ## List workspaces ... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx | main | terraform | [
-0.041315216571092606,
0.02540482021868229,
-0.01015679445117712,
0.010591491125524044,
-0.026697829365730286,
-0.025341838598251343,
-0.07154840230941772,
-0.07738129794597626,
0.03952997922897339,
0.06290274113416672,
-0.019635671749711037,
-0.10137863457202911,
0.013887861743569374,
-0.... | 0.0346 |
which behave identically. One refers to a workspace by its ID: `GET /workspaces/:workspace\_id` | Parameter | Description | | --------------- | ---------------- | | `:workspace\_id` | The workspace ID | The other refers to a workspace by its name and organization: `GET /organizations/:organization\_name/workspaces/:nam... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx | main | terraform | [
-0.07215937972068787,
0.012544212862849236,
-0.05977444350719452,
0.06532323360443115,
-0.03997914865612984,
-0.038206517696380615,
0.0224715955555439,
-0.0463469997048378,
0.07175655663013458,
-0.06750921905040741,
0.025196492671966553,
-0.05711847171187401,
0.018018178641796112,
-0.00078... | 0.057628 |
ID and the other endpoint identifies the workspace with its name and organization. `DELETE /workspaces/:workspace\_id` | Parameter | Description | | --------------- | --------------------------------- | | `:workspace\_id` | The ID of the workspace to delete | `DELETE /organizations/:organization\_name/workspaces/:name`... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx | main | terraform | [
-0.016956493258476257,
0.02724730782210827,
-0.05633843317627907,
0.03826918825507164,
0.00921214371919632,
-0.029639912769198418,
0.03810779005289078,
-0.09124018996953964,
0.0913132056593895,
-0.015621691010892391,
0.004479107912629843,
-0.041226066648960114,
0.026340864598751068,
0.0022... | 0.068747 |
or locked by a different user | ### Sample Request ```shell-session $ curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request POST \ https://app.terraform.io/api/v2/workspaces/ws-SihZTyXKfNXUWuUa/actions/unlock ``` ### Sample Response @include 'api-code-blocks/work... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx | main | terraform | [
-0.09532565623521805,
0.0012434181990101933,
-0.007638001348823309,
-0.01727418415248394,
-0.02032490260899067,
-0.029726922512054443,
-0.012900051660835743,
-0.08497858792543411,
0.059520937502384186,
0.11871219426393509,
-0.004717724863439798,
-0.016753194853663445,
0.016274718567728996,
... | 0.024435 |
endpoint. | This endpoint retrieves the list of other workspaces that are allowed to access the given workspace's state during runs according to the workspace's state-sharing configuration. The following table describes how Terraform Enterprise determines access to the state data: | Authorization type | Attributes | Re... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx | main | terraform | [
-0.009728326462209225,
-0.007047001738101244,
-0.008678131736814976,
0.0031206957064568996,
0.03303927183151245,
-0.010745376348495483,
0.020119480788707733,
-0.09856484085321426,
0.0284638199955225,
0.05826593562960625,
-0.021838245913386345,
-0.0357627347111702,
0.008790940977633,
0.0042... | 0.095483 |
error object | ### Request Body This PATCH endpoint requires a JSON object with the following properties as a request payload. Properties without a default value are required. | Key path | Type | Default | Description | | ------------- | ------ | ------- | ----------------------------------------------------------- | |... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx | main | terraform | [
-0.03159734234213829,
0.06380848586559296,
-0.017165828496217728,
0.012649447657167912,
-0.07785850763320923,
-0.03529740497469902,
0.012227440252900124,
0.01423587929457426,
0.004466892685741186,
0.058990199118852615,
-0.04396170377731323,
-0.08725325763225555,
-0.021508585661649704,
0.04... | 0.06249 |
state consumers from a workspace, according to the contents of the payload. You can only use this endpoint for workspaces where `global-remote-state` and `project-remote-state` are `false`. \* The workspaces specified as consumers must be readable to the API token that makes the request. \* You can safely remove a cons... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx | main | terraform | [
-0.08700941503047943,
0.03808605298399925,
-0.02166486717760563,
0.020513223484158516,
0.005928729195147753,
-0.06104768440127373,
-0.04457630217075348,
-0.059508923441171646,
0.022460877895355225,
0.011096207424998283,
0.015372092835605145,
-0.07475966215133667,
0.006074607837945223,
0.01... | 0.059917 |
Lists key-value tags directly bound to the workspace. - `GET /workspaces/:workspace\_id/effective-tag-bindings`: Lists all key-value tags bound to the workspace, including those inherited from the parent project. ### Path parameters | Parameter | Description | | --------------- | ---------------------------------------... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx | main | terraform | [
-0.014047039672732353,
0.04278210550546646,
-0.029143085703253746,
0.045690279453992844,
-0.01816863939166069,
-0.010373289696872234,
0.09007848054170609,
0.03522811830043793,
0.0041810451075434685,
-0.05276164412498474,
0.005056367255747318,
-0.07428209483623505,
0.026378097012639046,
-0.... | 0.002049 |
`DELETE /workspaces/:workspace\_id/relationships/tags` | Parameter | Description | | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `:workspace\_id` | The workspace ID to remove tag... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx | main | terraform | [
-0.05240079015493393,
0.07770909368991852,
-0.00935386586934328,
0.05782904103398323,
0.03238363936543465,
-0.0646304115653038,
0.04947584867477417,
-0.11604021489620209,
0.08428468555212021,
0.014802137389779091,
0.005839101038873196,
-0.06355349719524384,
0.041308362036943436,
-0.0175414... | -0.021195 |
{ "key": "bar", "value": "baz" } } ] } ``` ## Show data retention policy This endpoint is exclusive to Terraform Enterprise and is not available in HCP Terraform. `GET /workspaces/:workspace\_id/relationships/data-retention-policy` | Parameter | Description | | ---------------------| -----------------------------------... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx | main | terraform | [
-0.016446944326162338,
0.05104701966047287,
0.020023133605718613,
0.027858750894665718,
-0.04639606177806854,
0.05128186568617821,
0.026636047288775444,
-0.09091993421316147,
0.03477016091346741,
0.03174131363630295,
0.012959454208612442,
-0.08557627350091934,
0.0453655831515789,
-0.049362... | 0.007504 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/audit-trails-tokens.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [307]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/307 [404]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404 [JSON API document]: /terraform/cloud-docs/api-docs#json-api-documents [JSON API error object]: https://jsonapi.org/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/applies.mdx | main | terraform | [
-0.0668284073472023,
0.01898636296391487,
0.05389320105314255,
0.005449567921459675,
-0.023174498230218887,
-0.05492975190281868,
-0.06841515004634857,
-0.034653156995773315,
0.05326699838042259,
0.07290538400411606,
-0.023033058270812035,
-0.05347114056348801,
0.028521958738565445,
-0.004... | 0.046008 |
include a fallback mechanism which attempts to upload the state directly to HCP Terraform's backend storage system in these cases. This endpoint then makes the raw data from these failed uploads available to users who are authorized to read the state contents. | Status | Response | Reason | | ------- | ----------------... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/applies.mdx | main | terraform | [
-0.07395043224096298,
0.11413031071424484,
0.003036334179341793,
-0.006965418346226215,
-0.010809745639562607,
-0.024636292830109596,
-0.06968122720718384,
-0.01678571291267872,
-0.0326310396194458,
0.060651641339063644,
-0.018974926322698593,
-0.08797726780176163,
0.09766222536563873,
-0.... | 0.031236 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/cost-estimates.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/change-requests.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
### Sample response ```json { "data": { "type": "workspace\_change\_requests", "id": "wscr-jXQMBkPAFGD6eyFs", "attributes": { "subject": "[Action Required] Github Actions Pinning (SEC-100)", "message": "Some long description here", "archived-by": "user-2n4yj45149kf", "archived-at": "2024-08-12T10:12:44.745Z", "created-... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/change-requests.mdx | main | terraform | [
-0.06862957030534744,
0.03515424579381943,
-0.015453612431883812,
0.06094339117407799,
0.0033465938176959753,
-0.05778678506612778,
-0.05291913077235222,
-0.03226524963974953,
0.0808178037405014,
0.027408011257648468,
-0.014049218036234379,
-0.02247137948870659,
0.01212796475738287,
0.0390... | 0.019324 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
string | `null` | The branch of the VCS repository where HCP Terraform should retrieve the policy set. If empty, HCP Terraform uses the default branch. | | `data.attributes.vcs-repo.identifier` | string | | The VCS repository identifier in the format `/`. For example, `hashicorp/my-policy-set`. The format for Azure Dev... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
0.027349021285772324,
0.027516338974237442,
-0.015119390562176704,
-0.01526494137942791,
-0.04485762119293213,
0.029262568801641464,
0.029107723385095596,
0.0031707838643342257,
0.03482667729258537,
0.0925656110048294,
-0.03204675763845444,
-0.11734076589345932,
0.08157415688037872,
-0.034... | -0.006776 |
### Sample Payload ```json { "data": { "type": "policy-sets", "attributes": { "name": "production", "description": "This set contains policies that should be checked on all production infrastructure workspaces.", "global": false, "kind": "sentinel", "agent-enabled": true, "policy-tool-version": "0.23.0", "overridable":... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.011919575743377209,
0.05074569582939148,
-0.02973524108529091,
0.002467014128342271,
0.05505870655179024,
-0.07846598327159882,
0.018073802813887596,
-0.0255355816334486,
0.008932847529649734,
0.03842682018876076,
0.012809245847165585,
-0.0662478655576706,
-0.010572332888841629,
0.03939... | 0.119494 |
returns versioned sets, and a `false` value returns sets with individual policy relationships. If omitted, all policy sets are returned. | | `filter[kind]` | \*\*Optional.\*\* If specified, restricts results to those with the matching policy kind value. Valid values are `sentinel` and `opa`. | | `include` | \*\*Optiona... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.05473440885543823,
0.06630554050207138,
-0.011550777591764927,
0.049395304173231125,
0.06493991613388062,
0.018275290727615356,
0.029307182878255844,
-0.06222393363714218,
-0.03858476132154465,
0.028883222490549088,
0.031951770186424255,
-0.031051669269800186,
0.029650283977389336,
-0.0... | 0.059889 |
"/policy-sets/foo", "policy-update-patterns": [ "policies/cost-management/\*\*/\*.sentinel", "policies/shared/\*\*/\*.sentinel" ], "versioned": true, "vcs-repo": { "branch": "main", "identifier": "hashicorp/my-policy-sets", "ingress-submodules": false, "oauth-token-id": "ot-7Fr9d83jWsi8u23A" }, "created-at": "2018-09-1... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.029477393254637718,
0.04941730573773384,
-0.01051185093820095,
0.018092526122927666,
0.04556526243686676,
-0.04694593325257301,
-0.014010760933160782,
-0.04764501750469208,
0.056897446513175964,
0.0740417093038559,
0.012704710476100445,
-0.04625590890645981,
-0.028502631932497025,
0.024... | 0.119297 |
from HCP Terraform. Note that this option and `policies` relationships are mutually exclusive and may not be used simultaneously. | | `data.attributes.vcs-repo.branch` | string | (previous value) | The branch of the VCS repo. When empty, HCP Terraform uses the VCS provider's default branch value. | | `data.attributes.v... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
0.008363490924239159,
0.03356561064720154,
0.017800617963075638,
-0.02376784011721611,
-0.01534831803292036,
0.01645379140973091,
0.022712508216500282,
-0.0623321495950222,
0.07594466954469681,
0.07945232838392258,
0.005569541826844215,
-0.08862914144992828,
0.09686683863401413,
-0.0400423... | 0.015048 |
"created-at": "2018-09-11T18:21:21.784Z", "updated-at": "2018-09-11T18:21:21.784Z" }, "relationships": { "organization": { "data": { "id": "my-organization", "type": "organizations" } }, "policies": { "data": [ { "id": "pol-u3S5p2Uwk21keu1s", "type": "policies" } ] }, "projects": { "data": [ { "id": "prj-AwfuCJTkdai4xj... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.043306708335876465,
0.09768403321504593,
0.014061416499316692,
0.03464297205209732,
0.028998665511608124,
-0.06182517856359482,
0.006007549352943897,
-0.11002887040376663,
0.06523080915212631,
0.026808282360434532,
-0.006974407937377691,
-0.04673844948410988,
0.00792362354695797,
0.0224... | 0.003895 |
[ { "id": "prj-AwfuCJTkdai4xj9w", "type": "projects" }, { "id": "prj-2HRvNs49EWPjDqT1", "type": "projects" } ] } ``` ### Sample Request ```shell curl \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/vnd.api+json" \ --request POST \ --data @payload.json \ https://app.terraform.io/api/v2/policy-sets/po... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.0354795940220356,
0.08899881690740585,
0.007301510777324438,
0.00743034016340971,
-0.011941439472138882,
-0.0370447039604187,
-0.020643357187509537,
-0.03797402232885361,
0.051281336694955826,
0.08355771005153656,
-0.027727024629712105,
-0.10895558446645737,
0.021748647093772888,
0.0113... | 0.008682 |
``` ## Remove policies from the policy set `DELETE /policy-sets/:id/relationships/policies` | Parameter | Description | | --------- | -------------------------------------------------------------------------------------------------- | | `:id` | The ID of the policy set to remove policies from. Refer to [List Policy Set... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.060951270163059235,
0.08420389145612717,
-0.023286957293748856,
0.023966435343027115,
0.03073975443840027,
-0.013377014547586441,
0.09780001640319824,
-0.08582662045955658,
-0.025320103392004967,
0.01955421268939972,
0.06270942836999893,
-0.0010784536134451628,
0.018958671018481255,
-0.... | 0.02452 |
to [List Policy Sets](#list-policy-sets) for reference information about finding IDs. | -> \*\*Note:\*\* Policy sets marked as global cannot be detached from individual workspaces. | Status | Response | Reason | | ------- | ------------------------- | ----------------------------------------------------------- | | [204... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.10454265773296356,
0.04682415351271629,
-0.04956558346748352,
-0.007644025143235922,
0.05472780764102936,
-0.020610261708498,
0.06918369978666306,
-0.041332367807626724,
0.01566910929977894,
0.04534328356385231,
0.015287403017282486,
-0.042441628873348236,
0.02260376140475273,
0.0355002... | 0.128979 |
the policy set | | [404][] | [JSON API error object][] | Policy set not found, or user unauthorized to perform action | ### Sample Request ```shell curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request DELETE \ https://app.terraform.io/api/v2/policy-sets/polset-3... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.07842890918254852,
0.09002920985221863,
-0.011204433627426624,
-0.031405165791511536,
0.008294877596199512,
-0.023051591590046883,
-0.03499709069728851,
-0.01448056846857071,
0.017146538943052292,
0.10714433342218399,
0.0041137682273983955,
-0.04778547212481499,
0.03132496029138565,
-0.... | 0.01746 |
uploaded successfully, you can request the [Show Policy Set Version](#show-a-policy-set-version) endpoint again to verify that the status has changed from `pending` to `ready`. ## Available related resources The GET endpoints above can optionally return related resources for policy sets, if requested with [the `include... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.005052289925515652,
0.0178386177867651,
0.05383862182497978,
0.011372644454240799,
0.06476674228906631,
-0.017228592187166214,
-0.049470726400613785,
-0.11773620545864105,
-0.01192848477512598,
0.0903940498828888,
-0.0059126089327037334,
-0.04599077254533768,
0.03734423965215683,
-0.005... | -0.044451 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/teams.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.