content large_stringlengths 3 20.5k | url large_stringlengths 54 193 | branch large_stringclasses 4
values | source large_stringclasses 42
values | embeddings listlengths 384 384 | score float64 -0.21 0.65 |
|---|---|---|---|---|---|
[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 |
for available 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 ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/explorer.mdx | main | terraform | [
-0.0014631893718615174,
0.008168189786374569,
-0.03212546184659004,
0.07193364948034286,
0.03012586571276188,
0.0051345182582736015,
0.008018869906663895,
-0.08626221120357513,
0.010259152390062809,
0.004678433761000633,
-0.011707590892910957,
-0.09033256024122238,
0.012623773887753487,
0.... | 0.019704 |
this terraform version. | | `workspaces` | `string` | A comma-separated list of workspaces using this terraform version. | #### View Type: `providers` | Field | Type | Description | | ------------------| -------- | --------------------------------------------------------- | | `name` | `string` | The name of this provid... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/explorer.mdx | main | terraform | [
-0.040137067437171936,
-0.020627789199352264,
0.02208925597369671,
0.03501036763191223,
0.01274043321609497,
-0.010131544433534145,
0.02737954445183277,
-0.08229633420705795,
0.005591466091573238,
0.04638420790433884,
0.0017957153031602502,
-0.09320079535245895,
0.007859435863792896,
0.004... | 0.029207 |
`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`, `string` | Filters data to rows where the field does n... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/explorer.mdx | main | terraform | [
0.020255710929632187,
0.06004256010055542,
0.013838631100952625,
0.006985704880207777,
-0.054505523294210434,
0.012793036177754402,
0.05048130825161934,
0.02213176153600216,
-0.026775186881422997,
-0.021224619820713997,
0.001419155509211123,
-0.03232526779174805,
0.07049588114023209,
-0.04... | -0.036052 |
"run-9MmJaoQTvDCh5wUa", "current-run-status": "applied", "drifted": true, "external-id": "ws-igUVNQSYVXRkhYuo", "module-count": 0, "modules": null, "organization-name": "acme-corp", "project-external-id": "prj-uU2xNqGeG86U9WgT", "project-name": "web", "provider-count": 0, "providers": null, "resources-drifted": 3, "res... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/explorer.mdx | main | terraform | [
-0.0843803882598877,
-0.050608836114406586,
-0.059058696031570435,
0.001909147365950048,
0.02588273026049137,
-0.040420301258563995,
-0.020836716517806053,
-0.021404791623353958,
0.0301651731133461,
0.09166332334280014,
0.028444362804293633,
-0.13492409884929657,
0.03656719624996185,
-0.00... | 0.075443 |
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.filter.operator` | string | | The operator applied to field and value. | | `data.query.filter.value` | array... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/explorer.mdx | main | terraform | [
-0.002466326579451561,
0.10657664388418198,
0.022651946172118187,
0.04877056926488876,
0.00538641819730401,
-0.021998712792992592,
0.029997551813721657,
-0.03887506574392319,
0.02440343052148819,
0.0807732492685318,
-0.02756931073963642,
-0.03513889014720917,
0.0025662777479737997,
0.01845... | -0.009866 |
``` ### Sample response ```json { "data": { "id": "sq-P9Yn6Ad6EiVMz77s", "type": "explorer-saved-queries", "attributes": { "name": "my saved query", "created-at": "2024-10-11T16:18:51.442Z", "query": { "filter": [{ "field": "workspace\_name", "operator": "contains", "value": ["candy"], }, { "field": "workspace\_name", ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/explorer.mdx | main | terraform | [
-0.02062804251909256,
0.06686706095933914,
-0.015254594385623932,
0.10353457927703857,
-0.02486388571560383,
0.012318616732954979,
0.03219466283917427,
-0.04093113914132118,
0.03764040768146515,
-0.021016258746385574,
0.018696660175919533,
-0.0783044695854187,
0.005448366515338421,
0.05237... | 0.021078 |
distribution service","1.5.7","2023-12-13T15:48:16+00:00" "true","0","0","0","0","2023-08-18T16:24:59+00:00","run-9MmJaoQTvDCh5wUa","applied","true","ws-igUVNQSYVXRkhYuo","0","","acme-corp","prj-uU2xNqGeG86U9WgT","web","0","","3","3","1.4.5","acmecorp/api","2023-04-25T17:09:14+00:00","api-service","1.4.5","2023-12-13T1... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/explorer.mdx | main | terraform | [
-0.029209092259407043,
-0.0782448872923851,
-0.08145595341920853,
-0.040939997881650925,
0.026301655918359756,
-0.022037731483578682,
0.02930431254208088,
0.0011675888672471046,
0.009542113170027733,
0.030184661969542503,
0.04991122707724571,
-0.019237251952290535,
0.048585373908281326,
0.... | 0.110498 |
[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 |
https://app.terraform.io/api/v2/workspaces/change-requests/wscr-jXQMBkPAFGD6eyFs` ``` ### 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", "a... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/change-requests.mdx | main | terraform | [
-0.09113755077123642,
0.024833254516124725,
0.03869309276342392,
0.031137919053435326,
0.01927478238940239,
-0.07259581983089447,
-0.06434320658445358,
-0.08330056071281433,
0.08227723836898804,
0.10160734504461288,
-0.00994723942130804,
-0.06082848459482193,
0.02104640007019043,
0.0240551... | 0.025953 |
[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 |
{ "projects": { "data": [ { "id": "prj-AwfuCJTkdai4xj9w", "type": "projects" } ] }, "workspaces": { "data": [ { "id": "ws-2HRvNs49EWPjDqT1", "type": "workspaces" } ] }, "workspace-exclusions": { "data": [ { "id": "ws-FVVvzCDaykN1oHiw", "type": "workspaces" } ] } } } } ``` ### Sample payload with individual policy relat... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.04178436100482941,
0.09638090431690216,
0.0010142510291188955,
0.014095459133386612,
0.029662348330020905,
-0.05675838515162468,
0.01762772724032402,
-0.053512055426836014,
0.034173622727394104,
0.00036662688944488764,
0.0011686625657603145,
-0.08425430953502655,
0.030617836862802505,
0... | 0.007953 |
one or more of `projects`, `workspaces`, `workspace-exclusions`, `policies`, `newest\_version`, or `current\_version`. See the [relationships section](#relationships) for details. | | `page[number]` | \*\*Optional.\*\* If omitted, the endpoint will return the first page. | | `page[size]` | \*\*Optional.\*\* If omitted,... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.07671814411878586,
0.1018625944852829,
-0.015590991824865341,
0.02266470529139042,
0.01568642631173134,
-0.025136591866612434,
-0.03197765722870827,
-0.0969180017709732,
0.03804389759898186,
0.08292100578546524,
-0.013043956831097603,
-0.07948489487171173,
0.07217723876237869,
0.0006723... | 0.072821 |
"data": [ { "id": "ws-FVVvzCDaykN1oHiw", "type": "workspaces" } ] }, }, "links": { "self":"/api/v2/policy-sets/polset-3yVQZvHzf5j3WRJ1" } }, "included": [ { "id": "polsetver-m4yhbUBCgyDVpDL4", "type": "policy-set-versions", "attributes": { "source": "github", "status": "ready", "status-timestamps": { "ready-at": "2019-... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.04418023303151131,
0.08859925717115402,
-0.034685734659433365,
0.01454355102032423,
0.06710485368967056,
-0.03425951674580574,
-0.0043640583753585815,
-0.00285781966522336,
0.01388459000736475,
0.07687853276729584,
0.015252596698701382,
-0.0857950896024704,
0.007450493052601814,
0.01079... | 0.049487 |
format for Azure DevOps is `//\_git/`. | | `data.attributes.vcs-repo.oauth-token-id` | string | (previous value) | The OAuth token ID to use to connect to the VCS host. | | `data.attributes.vcs-repo.ingress-submodules` | boolean | (previous value) | Determines whether HCP Terraform instantiates repository submodules du... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.02632627636194229,
0.02196778729557991,
0.05127299204468727,
0.008522040210664272,
-0.026988990604877472,
0.0009030341752804816,
0.049946803599596024,
-0.07108166068792343,
0.04412086308002472,
0.12118002027273178,
-0.01445920579135418,
-0.06181647256016731,
0.08467474579811096,
-0.0079... | -0.024531 |
------- | ------------------------- | -------------------------------------------------------------------------- | | [204][] | No Content | The request was successful | | [404][] | [JSON API error object][] | Policy set not found or user unauthorized to perform action | | [422][] | [JSON API error object][] | Malformed... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.08664678782224655,
0.0465003065764904,
-0.04885751008987427,
-0.061465200036764145,
-0.019197450950741768,
-0.05792342126369476,
-0.05070282891392708,
0.0020565050654113293,
0.01776641421020031,
0.043176379054784775,
0.05989692732691765,
-0.017832059413194656,
-0.002509121084585786,
0.0... | 0.081201 |
API error object][] | Policy set not found or user unauthorized to perform action | | [422][] | [JSON API error object][] | Malformed request body (one or more workspaces not found, wrong types, etc.) | ### Request Body This POST endpoint requires a JSON object with the following properties as a request payload. Proper... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.058297690004110336,
0.053045853972435,
-0.012830016203224659,
-0.009436707012355328,
-0.0930820032954216,
-0.05307483673095703,
-0.031765151768922806,
-0.0037209063302725554,
0.010066655464470387,
0.004519333131611347,
-0.005369668360799551,
-0.07268588244915009,
-0.015007605776190758,
... | 0.044099 |
Body This DELETE 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/policy-sets.mdx | main | terraform | [
0.0032615966629236937,
0.023007575422525406,
0.008710754103958607,
-0.011619968339800835,
-0.050018444657325745,
-0.05958719551563263,
-0.015268411487340927,
-0.048812393099069595,
0.09102234244346619,
0.00007701788854319602,
-0.007805296685546637,
-0.04537500441074371,
-0.032095156610012054... | 0.036967 |
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.04561082646250725,
0.000992842367850244,
-0.049325134605169296,
-0.034551337361335754,
-0.09819324314594269,
0.012629598379135132,
-0.001735057681798935,
0.045651014894247055,
-0.005526287481188774,
-0.05774746090173721,
0.06401685625314713,
-0.0250454880297184,
-0.0320785790681839,
-0.... | 0.077915 |
| ------- | ----------------------------------------------------- | ----------------------------------------------------------- | | [201][] | [JSON API document][] (`type: "policy-set-versions"`) | The request was successful. | | [404][] | [JSON API error object][] | Policy set not found or user unauthorized to perform... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.0496106892824173,
0.05178620666265488,
-0.02482776902616024,
-0.06477871537208557,
0.0490233413875103,
-0.015557864680886269,
-0.07677581161260605,
-0.00962440762668848,
0.013647203333675861,
0.05769038572907448,
0.05040043964982033,
-0.033439651131629944,
-0.0204473789781332,
-0.009171... | 0.028528 |
The projects this policy set applies to. | | `workspaces` | The workspaces this policy set applies to. | | `workspace-exclusions` | The workspaces excluded from this policy set's enforcement. | The following resource types may be included for policy set versions: | Resource Name | Description | | ------------- | ------... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/policy-sets.mdx | main | terraform | [
-0.05482875928282738,
0.0022311147768050432,
-0.008640863932669163,
0.01669037900865078,
0.040817782282829285,
0.025184443220496178,
0.07745736837387085,
-0.10481426119804382,
0.011969547718763351,
0.008367292582988739,
0.02032698318362236,
-0.036658596247434616,
0.05901087448000908,
-0.01... | 0.000462 |
[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 |
false, "read-workspaces": false } }, "relationships": { "users": { "data": [] }, "authentication-token": { "meta": {} } }, "links": { "self": "/api/v2/teams/team-6p5jTwJQXwqZBncC" } } ] } ``` ## Create a Team `POST /organizations/:organization\_name/teams` | Parameter | Description | | -------------------- | ----------... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/teams.mdx | main | terraform | [
-0.059780191630125046,
0.06642360985279083,
-0.054124511778354645,
0.07330024242401123,
-0.051335182040929794,
-0.04475858062505722,
-0.047090042382478714,
-0.025201957672834396,
0.07818705588579178,
-0.044294197112321854,
0.007243589963763952,
-0.07878431677818298,
0.024825718253850937,
0... | 0.078556 |
be shown. | ### Sample Request ```shell $ curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request GET \ https://app.terraform.io/api/v2/teams/team-6p5jTwJQXwqZBncC ``` ### Sample Response The `sso-team-id` attribute is only returned in Terraform Enterprise 202204-1... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/teams.mdx | main | terraform | [
-0.0072343316860497,
0.11249234527349472,
0.010420962236821651,
0.02664399892091751,
0.005296227987855673,
0.009294518269598484,
-0.0626017302274704,
-0.07425162941217422,
0.06132444366812706,
0.061615776270627975,
-0.025075562298297882,
-0.1138392761349678,
0.03330521285533905,
0.02752405... | 0.0314 |
```json { "data": { "attributes": { "name": "team-creation-test", "sso-team-id": "cb265c8e41bddf3f9926b2cf3d190f0e1627daa4", "organization-access": { "manage-policies": false, "manage-policy-overrides": false, "manage-run-tasks": true, "manage-vcs-settings": true, "manage-agent-pools": false, "manage-workspaces": true,... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/teams.mdx | main | terraform | [
-0.04697224125266075,
0.00578287523239851,
-0.08185943961143494,
0.08907561004161835,
0.013784256763756275,
-0.023412130773067474,
-0.055644191801548004,
-0.04086567088961601,
0.025554386898875237,
0.036224182695150375,
0.047090645879507065,
-0.02774248830974102,
0.003081394825130701,
0.09... | 0.11318 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [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/format/#error-objects # Policy evaluations API reference Policy eval... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/policy-evaluations.mdx | main | terraform | [
-0.051727257668972015,
0.07324568927288055,
0.01851542666554451,
0.012231124565005302,
0.015937091782689095,
-0.021044133231043816,
-0.048581529408693314,
-0.05072639882564545,
0.030165260657668114,
0.07913190871477127,
-0.028261937201023102,
-0.05350099876523018,
0.05456877499818802,
0.00... | 0.076075 |
cuRL. #### All Policy Outcomes The following example call returns all policy set outcomes. ```shell curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request GET \ https://app.terraform.io/api/v2/policy-evaluations/poleval-8Jj9Hfoz892D9WMX/policy-set-outcomes ``` ###... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/policy-evaluations.mdx | main | terraform | [
-0.03393155336380005,
0.1255427747964859,
0.05688273534178734,
-0.018981395289301872,
0.03860821574926376,
-0.01661364734172821,
0.018315894529223442,
-0.04887380450963974,
0.05500056594610214,
0.05538962408900261,
-0.03935028985142708,
-0.096122145652771,
0.015570320188999176,
-0.00820135... | -0.008846 |
# API Changelog Keep track of changes to the API for HCP Terraform and Terraform Enterprise. ## 2025-12-18 \* Document the new `/registry-components` endpoints that let you read, publish, update, and delete Stack component configurations in your organization's private registry. For more details, refer to the [Stack com... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx | main | terraform | [
-0.004907364025712013,
0.0057039568200707436,
0.00972309336066246,
-0.029254591092467308,
-0.005068670492619276,
-0.0000267630548478337,
-0.059962041676044464,
-0.052993711084127426,
-0.023172173649072647,
0.04056626185774803,
-0.016056668013334274,
-0.0748496726155281,
0.01461454015225172,
... | 0.029925 |
beta tags from documentation for audit trail tokens. ## 2024-07-15 \* Update the [Team API](/terraform/cloud-docs/api-docs/teams) to include `allow-member-token-management`. ## 2024-07-12 \* Add beta tags to documentation for audit trail tokens. ## 2024-06-25 \* Add API documentation for new [team token management sett... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx | main | terraform | [
-0.030814602971076965,
0.007933614775538445,
0.016364414244890213,
0.02111370675265789,
0.03964073210954666,
-0.012965774163603783,
-0.008762096986174583,
-0.052100155502557755,
0.025774909183382988,
0.09567918628454208,
-0.020516710355877876,
-0.03554572910070419,
0.015531353652477264,
0.... | 0.067951 |
Update [Policy Evaluations API](/terraform/cloud-docs/api-docs/policy-evaluations) to include `policy-tool-version`. ## 2023-09-29 \* Add support for [streamlined run task reviews](/terraform/cloud-docs/integrations/run-tasks), enabling run task integrations to return high fidelity results. \* Update the [Terraform clo... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx | main | terraform | [
-0.05328909307718277,
0.024888845160603523,
0.029992345720529556,
0.02539677731692791,
0.02057448960840702,
-0.06199491396546364,
-0.07236504554748535,
-0.07013991475105286,
-0.01827721856534481,
0.12036449462175369,
-0.03368536755442619,
-0.046819280833005905,
0.039752066135406494,
0.0021... | 0.055605 |
the organization access settings of the [Team API](/terraform/cloud-docs/api-docs/teams). ## 2023-02-03 \* Updated the [List Runs API](/terraform/cloud-docs/api-docs/run#list-runs-in-a-workspace) to note that the filter query parameters accept comma-separated lists. ## 2023-01-18 \* Updated the [Team API](/terraform/cl... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx | main | terraform | [
-0.042912229895591736,
-0.005766687449067831,
0.0135189862921834,
0.022208813577890396,
0.006416768301278353,
-0.030170267447829247,
-0.04303411394357681,
-0.09787845611572266,
0.0463746003806591,
0.09324406087398529,
-0.04340042918920517,
-0.028719929978251457,
0.03789319843053818,
0.0356... | 0.021992 |
the run task to be configured. \* Update [Run Tasks](/terraform/cloud-docs/api-docs/run-tasks/run-tasks) to include the new description attribute. ### 2022-06-09 \* Updated [List Agent Pools](/terraform/cloud-docs/api-docs/agents#list-agent-pools) to accept a search parameter `q`, so that agent pools can be searched by... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx | main | terraform | [
-0.015114858746528625,
0.030144870281219482,
0.022342098876833916,
0.035541485995054245,
-0.0020936494693160057,
-0.0021348088048398495,
-0.017615552991628647,
-0.06055235490202904,
0.025612441822886467,
0.060374531894922256,
-0.03309835493564606,
-0.0926811620593071,
0.055320966988801956,
... | 0.028649 |
public registry module related APIs. \* \*\*DEPRECATION\*\*: The following [Registry Module APIs](/terraform/cloud-docs/api-docs/private-registry/modules) have been replaced with newer apis and will be removed in the future. \* The following endpoints to delete modules are replaced with [Module Delete APIs](/terraform/... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx | main | terraform | [
-0.0826798528432846,
0.0072306119836866856,
-0.005268672946840525,
0.004822602961212397,
0.006831107661128044,
-0.014271843247115612,
-0.03692900389432907,
-0.07356135547161102,
0.05369369685649872,
0.09771670401096344,
0.04723089933395386,
-0.006189545150846243,
0.0001219388359459117,
0.0... | 0.056663 |
[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/team-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 |
| Parameter | Description | |----------------------|----------------------------------------------------------| | `:organization\_name` | The name of the organization whose team tokens you want to list. | This endpoint returns object metadata and does not include secret authentication details of tokens. You can only vi... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/team-tokens.mdx | main | terraform | [
-0.023880861699581146,
0.05238085985183716,
-0.085907481610775,
0.030705656856298447,
0.006768336519598961,
0.024992549791932106,
0.007590248249471188,
0.033684976398944855,
0.011461310088634491,
0.006154341157525778,
0.0043151890859007835,
-0.082587331533432,
0.014087541028857231,
-0.0268... | 0.100542 |
that is not associated with a specific user. You can create and delete team tokens and list an organization's team tokens. The [team tokens API](/terraform/cloud-docs/api-docs/team-tokens) includes the same functionality as legacy team tokens, and allows you to provision multiple tokens with descriptions per team. ## G... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/team-tokens.mdx | main | terraform | [
-0.059593476355075836,
0.0355878621339798,
0.004033976700156927,
-0.005999711807817221,
-0.0067946333438158035,
-0.023057185113430023,
0.022642003372311592,
-0.05363176017999649,
0.09438084065914154,
0.06208662688732147,
-0.029084770008921623,
-0.04845624044537544,
0.05099128559231758,
0.0... | 0.059567 |
query string. You can search for a team authentication token using the team name. | | `sort` | \*\*Optional.\*\* Allows sorting the team tokens by `"team-name"`, `"created-by"`, `"expired-at"`, and `"last-used-at"`. Prepending a hyphen to the sort parameter reverses the order. For example, `"-team-name"` sorts by name ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/team-tokens.mdx | main | terraform | [
-0.05249689891934395,
0.109468474984169,
0.014147845096886158,
0.019092679023742676,
-0.030552448704838753,
-0.010671545751392841,
-0.037674885243177414,
-0.012981856241822243,
0.11137029528617859,
-0.013006615452468395,
0.009868769906461239,
0.022348864004015923,
0.0015475223772227764,
0.... | 0.000257 |
[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/variable-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 |
| ### Sample Payload ```json { "data": { "type": "varsets", "attributes": { "name": "MyVarset", "description": "Full of vars and such for mass reuse", "global": false, "priority": false, }, "relationships": { "workspaces": { "data": [ { "id": "ws-z6YvbWEYoE168kpq", "type": "workspaces" } ] }, "stacks": { "data": [ { "t... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/variable-sets.mdx | main | terraform | [
-0.0414169579744339,
0.021344313398003578,
0.024061765521764755,
0.07022221386432648,
-0.04375475272536278,
-0.02796776406466961,
0.004547442309558392,
0.002051128074526787,
0.04587773233652115,
-0.06522110104560852,
-0.009838267229497433,
-0.029788123443722725,
0.023614533245563507,
0.036... | -0.006383 |
[404][] | [JSON API error object][] | Organization or variable set not found, or user unauthorized to perform action | | [422][] | [JSON API error object][] | Problem with payload or request; details provided in the error object | ### Sample Payload ```json { "data": { "type": "varsets", "attributes": { "name": "MyVars... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/variable-sets.mdx | main | terraform | [
-0.04514900967478752,
0.02271134778857231,
0.00030139542650431395,
0.04365219920873642,
-0.047549474984407425,
-0.04372958466410637,
-0.02868577092885971,
-0.038976848125457764,
0.05553996190428734,
-0.011496386490762234,
0.014193505980074406,
-0.0050867111422121525,
0.024369368329644203,
... | 0.058392 |
the variable sets belong to | List all variable sets for a project. This includes global variable sets from the project's organization. `GET projects/:project\_id/varsets` | Parameter | Description | |---------------|----------------| | `:project\_id` | The project ID | List all variable sets for a workspace. This incl... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/variable-sets.mdx | main | terraform | [
-0.015565276145935059,
0.01939915120601654,
-0.011338411830365658,
0.037489935755729675,
-0.04517476260662079,
0.04491524025797844,
0.0358949676156044,
-0.06707169860601425,
-0.0006630608695559204,
0.0373832993209362,
-0.014513645321130753,
-0.06083158031105995,
0.08158007264137268,
-0.004... | 0.004709 |
to contain conflicting variables with the same name and type. You will receive a 422 response if you try to add a conflicting variable to a global variable set. | Status | Response | Reason(s) | | ------- | ------------------------- | --------------------------------------------------------------------- | | [200][] | [... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/variable-sets.mdx | main | terraform | [
-0.05381434038281441,
0.023353250697255135,
0.007181514985859394,
0.010440274141728878,
-0.05162103846669197,
-0.0724477469921112,
0.018102101981639862,
-0.014669062569737434,
0.03430020064115524,
-0.04781874269247055,
0.020792214199900627,
-0.061921119689941406,
0.03990376740694046,
0.060... | 0.033058 |
"first": "app.terraform.io/app/varsets/varset-992UMULdeDuebi1x/vars?page=1", "prev": null, "next": null, "last": "app.terraform.io/app/varsets/varset-992UMULdeDuebi1x/vars?page=1" } } ``` ## Apply Variable Set to Workspaces Accepts a list of workspaces to add the variable set to. `POST varsets/:varset\_id/relationships... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/variable-sets.mdx | main | terraform | [
-0.005400457419455051,
-0.009770901873707771,
-0.00042760634096339345,
0.0766400694847107,
-0.09002871066331863,
0.036867499351501465,
0.02166367881000042,
-0.04031476005911827,
-0.0001685611205175519,
0.07738225162029266,
-0.03197389468550682,
-0.09802663326263428,
0.052949149161577225,
-... | -0.03607 |
| | [404][] | [JSON API error object][] | Variable set not found or user unauthorized to perform action | | [422][] | [JSON API error object][] | Problem with payload or request; details provided in the error object | ### Sample Payload ```json { "data": [ { "type": "projects", "id": "prj-YwfuBJZkdai4xj9w" } ] } ``` ##... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/variable-sets.mdx | main | terraform | [
-0.021714096888899803,
0.08410993963479996,
-0.00853889249265194,
-0.007794144097715616,
-0.03047323226928711,
-0.04006281495094299,
-0.020718885585665703,
-0.027279432862997055,
0.05557290092110634,
0.05903538316488266,
-0.0054855505004525185,
-0.06500936299562454,
0.023249682039022446,
0... | 0.051328 |
`"stacks"` | | `data[].id` | string | | The ID of the Stack to delete the variable set from. | | Status | Response | Reason(s) | | ------- | ------------------------- | --------------------------------------------------------------------- | | [204][] | | Successfully removed variable set from the requested stacks | | [... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/variable-sets.mdx | main | terraform | [
-0.08858036994934082,
0.04046026989817619,
-0.010464878752827644,
0.04908023774623871,
-0.030642012134194374,
-0.08189012110233307,
0.006150463595986366,
-0.01171284168958664,
0.03691026568412781,
-0.03490021824836731,
0.03571934625506401,
-0.031916458159685135,
0.020032178610563278,
-0.00... | 0.072437 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [400]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400 [401]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401 [403]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/403 [404]: 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/assessment-results.mdx | main | terraform | [
-0.05895228311419487,
0.04872103035449982,
-0.05450577288866043,
0.016206445172429085,
-0.01324463076889515,
-0.07686988264322281,
-0.06857501715421677,
-0.04547417536377907,
0.014313585124909878,
-0.05567794665694237,
0.022435704246163368,
0.006416401360183954,
0.02293458767235279,
0.0088... | 0.066686 |
# API stability policy The HCP Terraform API will continue to evolve, but we consider it stable for general use, and HashiCorp will maintain all stable API endpoints in a backwards compatible manner. (Stable endpoints are any endpoints \_not\_ marked as beta.) If we need to make a change that we consider backwards inco... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/stability-policy.mdx | main | terraform | [
-0.06887973845005035,
0.0436895452439785,
0.05653303116559982,
-0.03045945055782795,
0.02139228954911232,
0.0008861026726663113,
-0.06923311203718185,
-0.02972543053328991,
-0.0354527048766613,
0.047825850546360016,
-0.0025944188237190247,
-0.03608905151486397,
0.021638570353388786,
-0.020... | 0.116265 |
[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/project-team-access.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 |
}, "links": { "related": "/api/v2/teams/team-KpibQGL5GqRAWBwT" } }, "project": { "data": { "id": "prj-ckZoJwdERaWcFHwi", "type": "projects" }, "links": { "related": "/api/v2/projects/prj-ckZoJwdERaWcFHwi" } } }, "links": { "self": "/api/v2/team-projects/tprj-TLznAnYdcsD2Dcmm" } } ], "links": { "self": "https://app.terr... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/project-team-access.mdx | main | terraform | [
-0.052283335477113724,
0.08922958374023438,
0.04489254951477051,
0.0034568144474178553,
0.031214391812682152,
-0.013341624289751053,
-0.05951623618602753,
-0.06271187961101532,
0.03898938372731209,
0.05738181248307228,
-0.022328225895762444,
-0.1021435484290123,
0.025747500360012054,
0.045... | 0.009257 |
`data.attributes.access` | string | | The type of access to grant. Valid values are `read`, `write`, `maintain`, `admin`, or `custom`. | | `data.relationships.project.data.type` | string | | Must be `projects`. | | `data.relationships.project.data.id` | string | | The project ID to which the team is to be added. | | `d... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/project-team-access.mdx | main | terraform | [
-0.04621409252285957,
0.026025863364338875,
-0.10604995489120483,
0.05109576880931854,
-0.04854827746748924,
-0.00476250471547246,
0.005785451736301184,
-0.03028061054646969,
0.014826975762844086,
0.011755538173019886,
-0.001775306067429483,
-0.01962323486804962,
0.0707409456372261,
0.0607... | -0.019708 |
"team": { "data": { "id": "team-xMGyoUhKmTkTzmAy", "type": "teams" }, "links": { "related": "/api/v2/teams/team-xMGyoUhKmTkTzmAy" } }, "project": { "data": { "id": "prj-ckZoJwdERaWcFHwi", "type": "projects" }, "links": { "related": "/api/v2/projects/prj-ckZoJwdERaWcFHwi" } } }, "links": { "self": "/api/v2/team-projects... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/project-team-access.mdx | main | terraform | [
-0.0477130189538002,
0.11554015427827835,
0.039053112268447876,
0.03310228884220123,
0.012874970212578773,
-0.015597760677337646,
-0.041640058159828186,
0.0026337027084082365,
0.014953546226024628,
0.030292876064777374,
0.0027735477779060602,
-0.04897685348987579,
-0.003073496511206031,
0.... | 0.040031 |
| "write" | "write" | "none" | | workspace-access.variables | "read" | "write" | "write" | "write" | "none" | | workspace-access.create | false | false | true | true | false | | workspace-access.locking | false | true | true | true | false | | workspace-access.delete | false | false | true | true | false | | workspace-... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/project-team-access.mdx | main | terraform | [
-0.00935837347060442,
-0.05040828511118889,
-0.1272471696138382,
0.11600159853696823,
-0.03897159546613693,
0.06963399052619934,
0.09365809708833694,
-0.022564681246876717,
-0.01155947893857956,
0.06229749694466591,
0.02104336954653263,
0.011946338228881359,
0.06206321343779564,
-0.0266240... | 0.096217 |
[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.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 |
| Events related to configuration versions. | | `notification\_configuration` | `create`, `update`, `destroy`, `enable` | Events related to notification configurations. | | `oauth\_client` | `create`, `update`, `destroy` | Events related to OAuth clients. | | `oauth\_token` | `index`, `show`, `update`, `destroy` | Even... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/audit-trails.mdx | main | terraform | [
-0.013998785987496376,
0.007008465006947517,
-0.031089719384908676,
-0.003334506880491972,
0.04583186283707619,
-0.04269297420978546,
0.057157084345817566,
-0.006797573529183865,
-0.017656195908784866,
0.03625301644206047,
0.01826578378677368,
0.023597080260515213,
0.04163900762796402,
-0.... | 0.122538 |
### Update Team Permissions An HCP Terraform organization emits this event when someone in your organization updates the permissions(`update\_team\_permissions`) of a team on a project. Alongside the [standard audit trail fields](#standard-response-fields), this event response includes the following fields: | Key | Dat... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/audit-trails.mdx | main | terraform | [
-0.0358579121530056,
0.09103061258792877,
0.022242845967411995,
0.008875439874827862,
0.06231776252388954,
-0.04419564828276634,
0.03652150556445122,
-0.13799597322940826,
0.04579374939203262,
0.06468775868415833,
0.029390932992100716,
-0.04014585539698601,
0.011152082122862339,
0.01775550... | 0.104213 |
| string | The ID of the associated workspace. | | `payload.workspace.name` | string | The name of the associated workspace. | | `payload.run.id` | string | The ID of the associated run. | | `payload.run.message` | string | The message associated with the run. | | `actor` | string | The policy owner. | Policy checks an... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/audit-trails.mdx | main | terraform | [
-0.03607356175780296,
0.05182841420173645,
0.023332340642809868,
-0.03686908259987831,
0.03495369106531143,
0.0009327336447313428,
0.023076031357049942,
-0.0755983367562294,
0.005061658099293709,
0.03253673389554024,
-0.013884207233786583,
-0.048279739916324615,
0.03914091736078262,
-0.008... | 0.106645 |
`task\_hmac\_key\_present` | boolean | Specifies if an HMAC key is present for the updated task. | | `task\_hmac\_key\_changed` | boolean | Indicates whether the HMAC key for the task has changed during the update. | ### Callback An HCP Terraform organization emits this event when a [run task](/terraform/cloud-docs/wor... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/audit-trails.mdx | main | terraform | [
-0.043408751487731934,
0.04396647587418556,
0.04326643794775009,
0.037460893392562866,
0.023098627105355263,
-0.04125183820724487,
0.04755846783518791,
-0.10995661467313766,
0.08687864243984222,
0.07963394373655319,
-0.012881710194051266,
-0.05111224204301834,
0.024547800421714783,
-0.0182... | 0.054309 |
someone in your organization destroys a workspace's associated run task (`workspace\_task`). Alongside the [standard audit trail fields](#standard-response-fields), this event response includes the following fields: | Key | Data Type | Description | | --- | --- | --- | | `task\_enforcement\_level` | string | The task's... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/audit-trails.mdx | main | terraform | [
-0.028391918167471886,
0.05205947533249855,
0.02547643519937992,
0.027484571561217308,
0.05805949866771698,
-0.04422275722026825,
0.03755511716008186,
-0.09481316804885864,
0.051500555127859116,
0.06618248671293259,
-0.02522442862391472,
-0.0840507447719574,
0.03911934792995453,
0.03217567... | 0.082775 |
[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/invoices.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/team-members.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 |
(With username) This method removes multiple users from a team using the username. Both users and teams must already exist. This method only removes a user from this team. It does not delete that user overall. `DELETE /teams/:team\_id/relationships/users` | Parameter | Description | | ---------- | ------------------- |... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/team-members.mdx | main | terraform | [
-0.05836748704314232,
0.049758486449718475,
-0.032608650624752045,
0.001955788815394044,
-0.06276758760213852,
-0.05318862944841385,
0.02314545027911663,
-0.051121387630701065,
0.09296315908432007,
-0.016058314591646194,
0.021541427820920944,
-0.01947331242263317,
0.04686050862073898,
0.04... | 0.056054 |
# Plan exports API reference Plan exports allow users to download data exported from the plan of a Run in a Terraform workspace. Currently, the only supported format for exporting plan data is to generate mock data for Sentinel. ## Create a plan export `POST /plan-exports` This endpoint exports data from a plan in the ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/plan-exports.mdx | main | terraform | [
-0.0503418929874897,
0.053855232894420624,
-0.038354482501745224,
0.0756860226392746,
0.05453535541892052,
-0.03753896430134773,
-0.0838109478354454,
-0.0333583690226078,
0.00032986566657200456,
0.08466919511556625,
-0.030451877042651176,
-0.02518824115395546,
-0.03853682801127434,
-0.0738... | 0.040583 |
"attributes": { "data-type": "sentinel-mock-bundle-v0", "status": "finished", "status-timestamps": { "queued-at": "2019-03-04T22:29:53+00:00", "finished-at": "2019-03-04T22:29:58+00:00", "expired-at": "2019-03-04T23:29:58+00:00" }, }, "relationships": { "plan": { "data": { "id": "plan-8F5JFydVYAmtTjET", "type": "plans"... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/plan-exports.mdx | main | terraform | [
-0.045524850487709045,
0.09527115523815155,
0.027992624789476395,
0.05105696991086006,
0.04645684361457825,
0.015738915652036667,
-0.031997475773096085,
0.015673957765102386,
0.007611432112753391,
0.013332628645002842,
0.023331059142947197,
-0.04448916018009186,
-0.03673822432756424,
0.038... | 0.028511 |
[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-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 |
the workspace that owns the variable. | | `:variable\_id` | The ID of the variable to be updated. | ### 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/workspace-variables.mdx | main | terraform | [
-0.0427742637693882,
0.019843917340040207,
0.004550270736217499,
0.06143905594944954,
-0.09054183214902878,
-0.021796630695462227,
0.0017591279465705156,
-0.01626402884721756,
-0.006076921243220568,
0.015339533798396587,
-0.017042063176631927,
-0.05994274467229843,
-0.023774391040205956,
-... | 0.065279 |
[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/team-access.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 |
[404][] | [JSON API error object][] | Team access not found or user unauthorized to perform action | | Parameter | Description | | --------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | `:id` | The ID of the team/works... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/team-access.mdx | main | terraform | [
-0.0742599293589592,
0.0873590037226677,
-0.05740441381931305,
0.012482436373829842,
-0.034913890063762665,
0.008589811623096466,
0.0013577851932495832,
-0.030880769714713097,
0.03648662194609642,
-0.04042103514075279,
0.04064469784498215,
-0.06675561517477036,
0.0070335171185433865,
0.069... | 0.069847 |
`data.relationships.workspace.data.id` | string | | The workspace ID to which the team is to be added. | | `data.relationships.team.data.type` | string | | Must be `teams`. | | `data.relationships.team.data.id` | string | | The ID of the team to add to the workspace. | ### Sample Payload ```json { "data": { "attributes... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/team-access.mdx | main | terraform | [
-0.057983674108982086,
-0.0007186975562945008,
-0.019229520112276077,
0.08171205967664719,
-0.009842931292951107,
-0.017482390627264977,
-0.04671464487910271,
-0.033245429396629333,
0.061152368783950806,
-0.02134832926094532,
-0.029987499117851257,
-0.013342083431780338,
0.014043197967112064... | 0.036226 |
"runs": "apply", "variables": "write", "state-versions": "none", "sentinel-mocks": "read", "workspace-locking": true, "run-tasks": true }, "relationships": { "team": { "data": { "id": "team-DBycxkdQrGFf5zEM", "type": "teams" }, "links": { "related": "/api/v2/teams/team-DBycxkdQrGFf5zEM" } }, "workspace": { "data": { "i... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/team-access.mdx | main | terraform | [
-0.06057044863700867,
0.01905273273587227,
-0.014788799919188023,
0.06284642219543457,
-0.0004812986881006509,
-0.023670116439461708,
-0.05162603780627251,
-0.04817371070384979,
-0.00881390180438757,
0.00837658904492855,
-0.003480189945548773,
-0.04610472172498703,
0.02305356226861477,
0.0... | 0.032314 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.