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 |
|---|---|---|---|---|---|
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. ## 2026-05-14 - The `concurrency-override` attribute has been removed from the [feature sets API](/terraform/cloud-docs/api-docs/feature-sets) response. ## 2026-04-24 - Add API documentation for the new [Metrics Service tokens]... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx | main | terraform | [
-0.022504456341266632,
-0.04650716856122017,
0.043396174907684326,
0.004977578297257423,
-0.002437510760501027,
0.010925785638391972,
-0.011346956714987755,
-0.07802270352840424,
0.04584202170372009,
0.08785010874271393,
-0.029679996892809868,
-0.07362207770347595,
0.031129799783229828,
0.... | 0.055686 |
team tokens](/terraform/cloud-docs/api-docs/team-tokens). ## 2024-08-01 This endpoint is exclusive to Terraform Enterprise, and not available in HCP Terraform. \* Update the [admin settings API](/terraform/enterprise/api-docs/admin/settings##update-general-settings) and [admin organizations API](/terraform/enterprise/a... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx | main | terraform | [
-0.04205558821558952,
0.06395173817873001,
0.046803586184978485,
0.027365628629922867,
0.010001599788665771,
0.012559454888105392,
-0.05712880566716194,
-0.06304740905761719,
0.011891249567270279,
0.0697818174958229,
-0.02682964876294136,
-0.04432537406682968,
0.0013442710041999817,
0.0392... | 0.090628 |
to the [Variable Sets API](/terraform/cloud-docs/api-docs/variable-sets). ## 2023-10-04 \* Updates to [run task integration API](/terraform/cloud-docs/api-docs/run-tasks/run-tasks-integration) \* Fix invalid JSON in the example payload. \* Clarify the expected JSON:API payload fields. \* Add `policy-tool-version` attri... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx | main | terraform | [
-0.0633501261472702,
0.0406697653234005,
0.04319421574473381,
-0.02629498951137066,
-0.014535609632730484,
0.010942984372377396,
-0.0403163805603981,
-0.06796467304229736,
-0.02133733406662941,
0.08749142289161682,
-0.01611793041229248,
-0.044618938118219376,
0.020004361867904663,
0.049516... | 0.015749 |
[Workspaces API](/terraform/cloud-docs/api-docs/workspaces) to accept `vcs-repo.github-app-installation-id` to connect a workspace to a GitHub App Installation. \* Updated [Registry Module API](/terraform/cloud-docs/api-docs/private-registry/modules) to accept `vcs-repo.github-app-installation-id` to connect to a GitHu... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx | main | terraform | [
-0.07596415281295776,
-0.058616045862436295,
-0.017315320670604706,
0.011469095014035702,
-0.021237939596176147,
0.007613169029355049,
-0.05231242626905441,
-0.037103548645973206,
0.04211214557290077,
0.11591053754091263,
-0.02232995070517063,
-0.04107632860541344,
0.05179340019822121,
0.0... | 0.044832 |
`allowed-workspaces` relationship to the request/response body of the below endpoints. This is available in Terraform Enterprise v202207-1 and later. \* [Show an Agent Pool](/terraform/cloud-docs/api-docs/agents#show-an-agent-pool) \* [Create an Agent Pool](/terraform/cloud-docs/api-docs/agents#create-an-agent-pool) \*... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx | main | terraform | [
-0.042222507297992706,
-0.008248635567724705,
0.015727616846561432,
0.025168390944600105,
-0.0010946291731670499,
-0.02588528022170067,
-0.03240370750427246,
-0.1022520661354065,
0.041731297969818115,
0.06314216554164886,
-0.03829663619399071,
-0.07668179273605347,
0.030237413942813873,
0.... | 0.055947 |
bug. \* [Workspaces](/terraform/cloud-docs/api-docs/workspaces): Added `locked\_by` as an includable related resource. \* Added [Run Tasks](/terraform/cloud-docs/api-docs/run-tasks/run-tasks) API endpoint. ### 2021-06-8 \* Updated [Registry Module APIs](/terraform/cloud-docs/api-docs/private-registry/modules). \* added... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx | main | terraform | [
-0.09628023952245712,
-0.04923050478100777,
0.024639291688799858,
0.03602539002895355,
0.002786620520055294,
-0.01605967804789543,
-0.053342606872320175,
-0.10862961411476135,
0.027828030288219452,
0.12775839865207672,
0.002131351502612233,
-0.021720709279179573,
0.02214863710105419,
0.041... | 0.050388 |
[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 |
filter by team name. `GET /organizations/:organization\_name/team-tokens` | Parameter | Description | |----------------------|----------------------------------------------------------| | `:organization\_name` | The name of the organization whose team tokens you want to list. | This endpoint returns object metadata and... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/team-tokens.mdx | main | terraform | [
-0.006198304705321789,
0.08086403459310532,
-0.06595619022846222,
0.01757180504500866,
0.03711474686861038,
-0.006424537394195795,
0.035615406930446625,
-0.013460136950016022,
0.02780240960419178,
-0.011688262224197388,
-0.012092690914869308,
-0.1009702980518341,
-0.0190194733440876,
0.005... | 0.063605 |
have a single legacy API token 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 w... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/team-tokens.mdx | main | terraform | [
-0.07785624265670776,
0.019689634442329407,
0.030674200505018234,
-0.020630454644560814,
0.001654717605561018,
-0.02322653867304325,
-0.0404977910220623,
-0.049453262239694595,
0.07365798950195312,
0.06415325403213501,
-0.04716861993074417,
-0.058094803243875504,
0.06787954270839691,
0.011... | 0.021163 |
the endpoint returns 20 tokens per page. | | `q` | \*\*Optional.\*\* A search 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... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/team-tokens.mdx | main | terraform | [
-0.05424399673938751,
0.10640500485897064,
-0.02220151573419571,
0.01611979678273201,
-0.03890049085021019,
0.00038890738505870104,
-0.03663606941699982,
0.00008450532186543569,
0.11467935889959335,
0.01582719013094902,
-0.0037212735041975975,
0.007706106174737215,
0.038448233157396317,
0.... | 0.040939 |
[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/cidr-range-lists.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 |
as a request payload. Properties without a default value are required. | Key path | Type | Default | Description | | --------------------------------- | ------ | ------------------------ | ------------------------------------- | | `data.type` | string | | Must be `"cidr-range-lists"`. | | `data.attributes.name` | strin... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/cidr-range-lists.mdx | main | terraform | [
-0.008964256383478642,
0.05487069487571716,
-0.07818002253770828,
0.008709654211997986,
-0.0036867992021143436,
-0.010090595111250877,
0.05514564365148544,
-0.04748714342713356,
-0.03561520203948021,
0.018643811345100403,
0.05176461488008499,
-0.08979468047618866,
0.024995004758238792,
0.0... | 0.002803 |
pool assignments are removed. | ### Sample payload ```json { "data": { "type": "cidr-range-lists", "attributes": { "name": "Updated Office Network", "description": "Updated IP ranges for all office locations", "enforcement-scope": "all\_agent\_pools" } } } ``` ### Sample request ```shell curl \ --header "Authorization:... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/cidr-range-lists.mdx | main | terraform | [
-0.04772108793258667,
0.05232405662536621,
0.03996578976511955,
-0.0010767054045572877,
0.012871459126472473,
-0.02872363105416298,
-0.01746465265750885,
-0.09311294555664062,
0.06465885788202286,
0.06286866962909698,
-0.01398715004324913,
-0.08425923436880112,
-0.01863960549235344,
0.0694... | -0.023743 |
range `GET /cidr-ranges/:id` | Parameter | Description | | --------- | ------------------------------ | | `:id` | The ID of the CIDR range to show | | Status | Response | Reason | | ------- | --------------------------------------------- | ------------------------------------------ | | [200][] | [JSON API document][] (... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/cidr-range-lists.mdx | main | terraform | [
-0.013353673741221428,
0.13342726230621338,
-0.08992891758680344,
-0.00546253053471446,
-0.003157824743539095,
0.023972919210791588,
-0.029912393540143967,
-0.01836298406124115,
0.04667358845472336,
-0.0770314633846283,
0.06307518482208252,
-0.10258599370718002,
0.03348199278116226,
-0.000... | 0.06797 |
``` ## Remove agent pools from an IP allowlist `DELETE /cidr-range-lists/:id/relationships/agent-pools` | Parameter | Description | | --------- | ------------------------------------------------------- | | `:id` | The ID of the IP allowlist to remove agent pools from | This endpoint removes the association between agen... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/cidr-range-lists.mdx | main | terraform | [
-0.03798962011933327,
0.08627969771623611,
-0.047875165939331055,
-0.009562386199831963,
0.04328662157058716,
-0.008814245462417603,
0.016398966312408447,
-0.11312758177518845,
0.010736717842519283,
-0.04641899839043617,
0.08109524846076965,
-0.017382878810167313,
0.015337875112891197,
0.0... | 0.086177 |
[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 |
[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/reserved-tag-keys.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 key targeted by this reserved tag key. | | `data.attributes.disable-overrides` | boolean | none | If `true`, disables overriding inherited tags with the specified key at the workspace level. | ### Sample payload ```json { "data": { "id": "rtk-Tj86UdGahKGDiYXY", "type": "reserved-tag-keys", "attributes": { "key": ... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/reserved-tag-keys.mdx | main | terraform | [
-0.0536404587328434,
0.1272617131471634,
0.005730409175157547,
0.0027579606976360083,
0.0366925373673439,
-0.05790616199374199,
0.011378965340554714,
-0.03501487150788307,
0.03679583594202995,
0.11918734014034271,
-0.008936651982367039,
-0.06952478736639023,
0.04064081236720085,
-0.0131594... | 0.009803 |
[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/feature-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 |
as `%5D` if your tooling doesn't automatically encode URLs. If neither pagination query parameters are provided, the endpoint will not be paginated and will return all results. | Parameter | Description | | -------------- | ----------------------------------------------------------------------------------------- | | `p... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/feature-sets.mdx | main | terraform | [
-0.02089894376695156,
0.07444686442613602,
-0.05986679717898369,
0.007443377282470465,
-0.06607835739850998,
0.0013362671015784144,
-0.045142997056245804,
-0.04394196346402168,
-0.001650638529099524,
0.027042802423238754,
0.019174331799149513,
-0.08710671961307526,
0.06474243104457855,
-0.... | -0.019374 |
[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-tags.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 |
id of the tag to remove. | ### Sample Payload ```json { "data": [ { "type": "tags", "id": "tag-Yfha4YpPievQ8wJw" } ] } ``` ### Sample Request ```shell curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request DELETE \ --data @payload.json \ https://app.terraform.io/a... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/organization-tags.mdx | main | terraform | [
-0.03181671351194382,
0.09672395884990692,
0.005440311040729284,
0.021148696541786194,
0.017301589250564575,
-0.10057058930397034,
-0.028855010867118835,
-0.0903264507651329,
0.07257045805454254,
0.034078218042850494,
0.007936234585940838,
-0.060335297137498856,
0.011925848200917244,
0.010... | 0.051321 |
[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/state-versions.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 |
| `state-version` | The version of the internal state format used for this state. Different Terraform versions read and write different format versions, but it only changes infrequently. | | `status` | Indicates a state version's content upload [status](/terraform/enterprise/api-docs/state-versions#state-version-status... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/state-versions.mdx | main | terraform | [
-0.0104310167953372,
0.010393260978162289,
0.03928743302822113,
-0.010276814922690392,
0.03433943912386894,
-0.012630770914256573,
-0.05199931189417839,
-0.10221486538648605,
0.039622727781534195,
0.072667695581913,
-0.023881621658802032,
-0.02102678082883358,
0.013101019896566868,
-0.0316... | 0.051871 |
last 100 are retained for six months, and are then deleted. -> \*\*Note:\*\* You cannot access this endpoint with [organization tokens](/terraform/cloud-docs/users-teams-organizations/api-tokens#organization-api-tokens). You must access it with a [user token](/terraform/cloud-docs/users-teams-organizations/users#api-to... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/state-versions.mdx | main | terraform | [
-0.034164074808359146,
0.04758021980524063,
0.035324230790138245,
0.012013575993478298,
0.031794674694538116,
-0.03580533713102341,
-0.0528382882475853,
-0.054724421352148056,
0.1107371523976326,
0.09561988711357117,
-0.0022384924814105034,
-0.026919052004814148,
0.010405147448182106,
-0.0... | 0.056201 |
### Sample Request In the below example, `@filename` is the name of Terraform state file you wish to upload. ```shell curl \ --header "Content-Type: application/octet-stream" \ --request PUT \ --data-binary @filename \ https://archivist.terraform.io/v1/object/4c44d964-eba7-4dd5-ad29-1ece7b99e8da ``` ## List State Versi... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/state-versions.mdx | main | terraform | [
-0.0289582721889019,
0.03326373174786568,
0.006408011075109243,
-0.045399218797683716,
-0.04224444553256035,
0.010056122206151485,
-0.10197591781616211,
-0.07032822072505951,
0.005527684930711985,
0.1298910677433014,
-0.05190907046198845,
-0.025956828147172928,
0.04490005970001221,
0.01040... | 0.02824 |
[workspace settings](/terraform/cloud-docs/workspaces/settings) or the [Show Workspace](/terraform/cloud-docs/api-docs/workspaces#show-workspace) endpoint. | Fetches the current state version for the given workspace. This state version will be the input state when running terraform operations. Viewing state versions re... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/state-versions.mdx | main | terraform | [
-0.01773301139473915,
0.04047410935163498,
0.03733431175351143,
0.006876502186059952,
0.00542563246563077,
-0.022580593824386597,
-0.06907131522893906,
-0.09946572780609131,
0.031611327081918716,
0.07337964326143265,
-0.03466486930847168,
-0.033668868243694305,
0.0012794543290510774,
-0.00... | 0.000293 |
} } ``` ## Rollback to a Previous State Version `PATCH /workspaces/:workspace\_id/state-versions` | Parameter | Description | |-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/state-versions.mdx | main | terraform | [
-0.07248768210411072,
0.03160032257437706,
0.025056971237063408,
0.016310853883624077,
-0.06108654662966728,
0.036876991391181946,
0.007747410796582699,
-0.04792327433824539,
-0.05106062814593315,
-0.019044024869799614,
0.03663184866309166,
0.030816959217190742,
-0.022711878642439842,
-0.0... | 0.059559 |
[State Version Status](#state-version-status) for information about all data states. This endpoint can only soft delete state versions that are in an [`finalized` state](#state-version-status) and are not the current state version. Otherwise, calling this endpoint results in an error. You must have organization owner p... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/state-versions.mdx | main | terraform | [
-0.009799609892070293,
0.08451278507709503,
0.022076798602938652,
-0.0018619780894368887,
0.018200349062681198,
-0.05641178786754608,
-0.020902015268802643,
-0.12355480343103409,
0.03425632789731026,
0.08375702798366547,
-0.011518290266394615,
-0.057122278958559036,
-0.006559779401868582,
... | 0.04045 |
{ "created-at": "2021-06-08T01:22:03.794Z", "size": 940, "hosted-state-download-url": "https://archivist.terraform.io/v1/object/...", "hosted-state-upload-url": null, "hosted-json-state-download-url": "https://archivist.terraform.io/v1/object/...", "hosted-json-state-upload-url": null, "status": "uploaded", "intermedia... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/state-versions.mdx | main | terraform | [
-0.03489664942026138,
0.05274496600031853,
0.01169181615114212,
0.010994021780788898,
0.017303980886936188,
-0.05427134409546852,
-0.07128389924764633,
-0.051782041788101196,
0.001559903146699071,
0.1352338045835495,
-0.001042487332597375,
-0.05499855428934097,
0.020840806886553764,
0.0402... | 0.040559 |
resources, if requested with [the `include` query parameter](/terraform/cloud-docs/api-docs#inclusion-of-related-resources). The following resource types are available: \* `created\_by` - The user that created the state version. For state versions created via a run executed by HCP Terraform, this is an internal user ac... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/state-versions.mdx | main | terraform | [
-0.024675210937857628,
0.0537431575357914,
0.05322576314210892,
0.02088802680373192,
0.015108452178537846,
-0.007447168696671724,
0.017008626833558083,
-0.09317097067832947,
0.004155981354415417,
0.022801775485277176,
-0.03320755064487457,
-0.058646589517593384,
0.07840230315923691,
-0.042... | 0.028656 |
[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/ssh-keys.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][] | [JSON API document][] (`type: "ssh-keys"`) | Success | | [404][] | [JSON API error object][] | SSH key not found or user not authorized | ### Sample Request ```shell curl \ --header "Authorization: Bearer $TOKEN" \ https://app.terraform.io/api/v2/ssh-keys/sshkey-GxrePWre1Ezug7aM ``` ### Sample Response ``... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/ssh-keys.mdx | main | terraform | [
-0.007667006459087133,
0.08220629394054413,
-0.009162702597677708,
-0.009135933592915535,
-0.034437086433172226,
-0.03894437476992607,
-0.046802349388599396,
-0.018260126933455467,
0.04251592233777046,
0.05916083604097366,
0.019204996526241302,
-0.07235666364431381,
0.024759678170084953,
0... | 0.026197 |
"name": "SSH Key for GitHub" } } } ``` ### Sample Request ```shell curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request PATCH \ --data @payload.json \ https://app.terraform.io/api/v2/ssh-keys/sshkey-GxrePWre1Ezug7aM ``` ### Sample Response ```json { "data": { "a... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/ssh-keys.mdx | main | terraform | [
-0.023704927414655685,
0.0564708337187767,
0.01372962910681963,
-0.003946744371205568,
-0.0022325506433844566,
-0.038386132568120956,
-0.01073620654642582,
-0.04083554446697235,
0.04408019781112671,
0.0878433808684349,
0.0029240595176815987,
-0.06674963235855103,
0.04270590469241142,
0.006... | 0.025 |
[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-set-params.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 |
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-set-params.mdx | main | terraform | [
0.007096482440829277,
0.045165661722421646,
-0.02767917513847351,
0.03229214623570442,
-0.10166280716657639,
-0.07216241210699081,
-0.0037961092311888933,
0.005245199892669916,
0.025095220655202866,
-0.022190706804394722,
-0.0491277240216732,
-0.11260432004928589,
0.025116413831710815,
0.0... | 0.013053 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [404]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404 [JSON API document]: /terraform/cloud-docs/api-d... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/metrics-service-tokens.mdx | main | terraform | [
-0.09009388089179993,
0.03344869613647461,
-0.005760783329606056,
0.016515005379915237,
-0.03813014551997185,
-0.0896037146449089,
-0.06258014589548111,
-0.03916522115468979,
0.04787266626954079,
0.053973473608493805,
-0.0022449109237641096,
-0.048605360090732574,
0.04849924519658089,
0.04... | 0.059159 |
"Content-Type: application/vnd.api+json" \ --request DELETE \ https://app.terraform.io/api/v2/organizations/my-organization/metrics-tokens/abc123def456ghi789jkl012mno345pqr ``` | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/metrics-service-tokens.mdx | main | terraform | [
-0.04004241153597832,
0.03191926330327988,
0.011801066808402538,
-0.000966737512499094,
0.01229268778115511,
-0.05951518565416336,
-0.025679653510451317,
-0.04509908705949783,
0.0968765839934349,
0.070916548371315,
-0.0019037601305171847,
-0.056710097938776016,
-0.015017950907349586,
0.063... | 0.092118 |
[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/organizations.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, "can-create-workspace": true, "can-manage-users": true, "can-manage-subscription": true, "can-manage-sso": false, "can-update-oauth": true, "can-update-sentinel": false, "can-update-ssh-keys": true, "can-update-api-token": true, "can-traverse": true, "can-start-trial": true, "can-update-agent-pools": false, "can... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/organizations.mdx | main | terraform | [
-0.07497815042734146,
-0.09230618923902512,
-0.14304780960083008,
0.03565707057714462,
0.04064434766769409,
-0.01835588365793228,
0.03320130333304405,
-0.08006225526332855,
-0.04618522524833679,
0.04741784930229187,
0.10333145409822464,
0.013440841808915138,
0.06085674464702606,
0.04864866... | 0.157797 |
`data.attributes.email` | string | | Admin email address | | `data.attributes.session-timeout` | integer | 20160 | Session timeout after inactivity (minutes) | | `data.attributes.session-remember` | integer | 20160 | Session expiration (minutes) | | `data.attributes.collaborator-auth-policy` | string | password | Authe... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/organizations.mdx | main | terraform | [
0.007683408446609974,
0.018575863912701607,
0.01942772977054119,
0.07758435606956482,
0.008553079329431057,
-0.04414800927042961,
-0.010256879962980747,
-0.07387298345565796,
0.03643735125660896,
0.13466623425483704,
-0.035089414566755295,
-0.07814391702413559,
0.025258423760533333,
0.0074... | -0.021336 |
true, "can-destroy": true, "can-access-via-teams": true, "can-create-module": true, "can-create-team": false, "can-create-workspace": true, "can-manage-users": true, "can-manage-subscription": true, "can-manage-sso": false, "can-update-oauth": true, "can-update-sentinel": false, "can-update-ssh-keys": true, "can-update... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/organizations.mdx | main | terraform | [
-0.0756801888346672,
-0.056104645133018494,
-0.13285993039608002,
0.013286626897752285,
0.05414670705795288,
-0.019683020189404488,
0.008721534162759781,
-0.08555930852890015,
-0.03498971462249756,
0.0473579578101635,
0.09460484981536865,
0.033122316002845764,
0.06165364384651184,
0.044062... | 0.174259 |
(nothing) | \*\*Optional.\*\* \*\*SAML only\*\* The name of the ["owners" team](/terraform/enterprise/saml/team-membership#managing-membership-of-the-owners-team) | | `data.attributes.assessments-enforced` | boolean | false | Whether or not to compel health assessments for all eligible workspaces. When true, health ass... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/organizations.mdx | main | terraform | [
-0.03481177240610123,
0.013277469202876091,
0.018439881503582,
0.07997250556945801,
0.03153509274125099,
-0.033696938306093216,
0.016733434051275253,
-0.17988045513629913,
0.01762865111231804,
0.07928686589002609,
0.035877253860235214,
-0.02593293972313404,
0.05644712969660759,
0.061672650... | -0.030872 |
the Entitlement Set This endpoint shows the [entitlements](/terraform/cloud-docs/api-docs#feature-entitlements) for an organization. `GET /organizations/:organization\_name/entitlement-set` | Parameter | Description | | -------------------- | ------------------------------------------------------ | | `:organization\_na... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/organizations.mdx | main | terraform | [
-0.020131617784500122,
0.0442391037940979,
0.012536589056253433,
-0.035117004066705704,
0.004263924900442362,
-0.006638870108872652,
-0.046204548329114914,
-0.018424082547426224,
0.006974187679588795,
0.0796993151307106,
-0.010114057920873165,
-0.1474195122718811,
0.03312566131353378,
-0.0... | 0.033744 |
[organization data retention policies](/terraform/enterprise/users-teams-organizations/organizations#data-retention-policies). Refer to [Data Retention Policy API](/terraform/enterprise/api-docs/data-retention-policies#create-or-update-data-retention-policy) in the Terraform Enterprise documentation for details. ## Rem... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/organizations.mdx | main | terraform | [
-0.07544413208961487,
0.03987163305282593,
-0.011742066591978073,
0.02086774632334709,
0.010923333466053009,
-0.03412312641739845,
0.004082836210727692,
-0.1299840211868286,
0.0784091129899025,
0.06848832219839096,
0.05977651849389076,
0.005087933503091335,
0.030159935355186462,
-0.0072802... | 0.127225 |
[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/run-triggers.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](/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/run-triggers.mdx | main | terraform | [
-0.018209317699074745,
0.08186934888362885,
0.0195670984685421,
0.027684751898050308,
-0.07306771725416183,
-0.019785350188612938,
-0.03924481198191643,
-0.0318676121532917,
0.04454028978943825,
0.07389137148857117,
-0.04503300040960312,
-0.11704976111650467,
0.06620258837938309,
-0.074290... | -0.048749 |
user unauthorized to perform action | ### Permissions In order to delete a run trigger, the user must have admin access to the specified workspace. ([More about permissions.](/terraform/cloud-docs/users-teams-organizations/permissions)) [permissions-citation]: #intentionally-unused---keep-for-maintainers ### Sample Req... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/run-triggers.mdx | main | terraform | [
-0.03001217730343342,
0.041803788393735886,
0.006231255363672972,
0.00166314747184515,
0.02405349351465702,
-0.03149864077568054,
0.023167703300714493,
-0.10127904266119003,
0.059123169630765915,
0.07428470253944397,
-0.012721248902380466,
-0.0195756908506155,
0.05197416990995407,
0.010970... | 0.028245 |
[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-memberships.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 |
"email": "test@example.com", "permissions": { "can-create-organizations": true, "can-change-email": true, "can-change-username": true, "can-manage-user-tokens": false } }, "relationships": { "authentication-tokens": { "links": { "related": "/api/v2/users/user-J8oxGmRk5eC2WLfX/authentication-tokens" } } }, "links": { "s... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/organization-memberships.mdx | main | terraform | [
-0.06992997974157333,
0.06155386567115784,
-0.028994468972086906,
0.06900226324796677,
0.008307725191116333,
-0.047402918338775635,
0.008596941828727722,
0.007908963598310947,
-0.015139051713049412,
-0.026674384251236916,
0.007124691270291805,
-0.07850342243909836,
0.010350373573601246,
0.... | 0.051664 |
| --------------------------- | | `:organization\_membership\_id` | The organization membership | | Status | Response | Reason | | ------- | ---------------------------------------------------------- | ------------------------------------------------------------------------- | | [200][] | [JSON API document][] (`type: ... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/organization-memberships.mdx | main | terraform | [
-0.07917819172143936,
0.09006436914205551,
-0.03600943088531494,
0.026409577578306198,
0.01922125183045864,
-0.05838383361697197,
-0.022416653111577034,
-0.009589803405106068,
0.032551538199186325,
-0.05648570880293846,
0.045176345854997635,
-0.06369882076978683,
0.019120318815112114,
0.02... | 0.125067 |
[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 [304]: 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/ip-ranges.mdx | main | terraform | [
-0.02449185587465763,
-0.019733238965272903,
-0.030942430719733238,
-0.02112526074051857,
-0.019326798617839813,
-0.09733036160469055,
-0.06041740998625755,
-0.08997057378292084,
0.004740177188068628,
-0.034597769379615784,
0.031186483800411224,
0.054574549198150635,
0.0010920173954218626,
... | 0.068166 |
[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 # State version outputs API reference State ve... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/state-version-outputs.mdx | main | terraform | [
-0.06838908046483994,
0.08460360765457153,
0.02596317045390606,
0.0326547846198082,
0.0027171040419489145,
-0.03048485703766346,
-0.04839405044913292,
-0.11316126585006714,
0.05154920369386673,
0.023535238578915596,
-0.031231358647346497,
-0.06715958565473557,
0.04904667288064957,
-0.00489... | 0.060359 |
```shell curl \ --header "Authorization: Bearer $TOKEN" \ https://app.terraform.io/api/v2/state-version-outputs/wsout-J2zM24JPFbfc7bE5 ``` ### Sample Response ```json { "data": { "id": "wsout-J2zM24JPFbfc7bE5", "type": "state-version-outputs", "attributes": { "name": "flavor", "sensitive": false, "type": "string", "val... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/state-version-outputs.mdx | main | terraform | [
-0.04675070568919182,
0.09233995527029037,
0.013487919233739376,
0.00957033596932888,
0.0005214165430516005,
-0.026981448754668236,
-0.0571274571120739,
-0.05447385832667351,
0.03099186345934868,
0.08060240000486374,
-0.0383293442428112,
-0.0890028178691864,
-0.02119830809533596,
0.0065980... | 0.067141 |
[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/users.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/user-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 |
"created-by": { "data": { "id": "user-MA4GL63FmYRpSFxa", "type": "users" } } } } } ``` ## Create a User Token `POST /users/:user\_id/authentication-tokens` | Parameter | Description | | ---------- | ------------------- | | `:user\_id` | The ID of the User. | Use the [Account API](/terraform/cloud-docs/api-docs/account)... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/user-tokens.mdx | main | terraform | [
-0.05165969207882881,
0.040172796696424484,
0.02368374541401863,
0.0356009416282177,
-0.021967824548482895,
-0.014013595879077911,
0.02743985876441002,
-0.011676901020109653,
0.07422006875276566,
0.10708039999008179,
-0.027000175788998604,
-0.0790635347366333,
0.0684080719947815,
-0.026323... | 0.022822 |
Follow this template to format each API method. There are usually multiple sections like this on a given API endpoint page. [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/Sta... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/_template.mdx | main | terraform | [
-0.03183702006936073,
0.07935114204883575,
-0.04898053780198097,
0.025842592120170593,
-0.011522671207785606,
-0.05650189518928528,
-0.10380014777183533,
-0.017093971371650696,
-0.01641135662794113,
-0.018458828330039978,
-0.04605792462825775,
0.038061413913965225,
0.006437865551561117,
-0... | 0.023685 |
```json { "data": { "id":"som-EavQ1LztoRTQHSNT", "type":"somethings", "attributes": { "sensitive":true, "category":"red", }, "relationships": { "configurable": { "data": { "id":"ws-4j8p6jX1w33MiDC7", "type":"workspaces" }, "links": { "related":"/api/v2/organizations/my-organization/workspaces/my-workspace" } } }, "link... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/_template.mdx | main | terraform | [
-0.016976116225123405,
0.05987115949392319,
-0.007391070481389761,
0.0621601939201355,
0.00783896166831255,
0.011804873123764992,
-0.05926051735877991,
0.0009327655425295234,
0.007850016467273235,
-0.048824068158864975,
0.040379565209150314,
-0.040555015206336975,
-0.024810222908854485,
0.... | 0.010261 |
[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/run.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 |
our aim is to always have capacity. However, in Terraform Enterprise this status will be more common due to the self-hosted nature. | | `applying` | Terraform is applying the changes specified in the plan. | | `applied` | Terraform has applied the changes specified in the plan. | | `discarded` | The run has been discar... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/run.mdx | main | terraform | [
0.0257315244525671,
-0.005601236596703529,
0.030485861003398895,
0.05626257136464119,
-0.04577863588929176,
-0.06552805751562119,
-0.062478214502334595,
-0.05732199177145958,
0.01962863840162754,
0.10325832664966583,
-0.047784674912691116,
0.0005671371472999454,
0.02536190301179886,
-0.039... | 0.056459 |
[Variable Precedence](/terraform/cloud-docs/variables#precedence) for more information. All values must be expressed as an HCL literal in the same syntax you would use when writing Terraform code. Refer to [Types](/terraform/language/expressions/types#types) in the Terraform documentation for more details. Setting `deb... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/run.mdx | main | terraform | [
0.0009311398025602102,
0.06796950846910477,
0.040164463222026825,
0.03945527970790863,
-0.04037373885512352,
-0.023068411275744438,
-0.009750060737133026,
-0.09050390124320984,
0.048454396426677704,
0.06897619366645813,
0.01532684825360775,
-0.08189813792705536,
0.025402365252375603,
0.045... | -0.026211 |
in this run. Only valid for plan-only runs; must be a valid Terraform version available to the organization. | | `data.relationships.workspace.data.id` | string | none | Specifies the workspace ID to execute the run in. | | `data.relationships.configuration-version.data.id` | string | none | Specifies the configuration... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/run.mdx | main | terraform | [
-0.015572095289826393,
0.016460172832012177,
0.03776957094669342,
0.032496750354766846,
-0.02179521881043911,
-0.03768628090620041,
-0.10260257869958878,
-0.10276414453983307,
0.020229201763868332,
0.06941959261894226,
-0.042367611080408096,
-0.04243158549070358,
-0.004419221077114344,
-0.... | -0.049919 |
Request Body This POST endpoint allows an optional JSON object with the following properties as a request payload. | Key path | Type | Default | Description | |-----------|--------|---------|------------------------------------| | `comment` | string | `null` | An optional comment about the run. | ### Sample Payload Thi... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/run.mdx | main | terraform | [
-0.047493208199739456,
0.05218978971242905,
-0.011843465268611908,
0.01159210316836834,
-0.059622325003147125,
-0.07190551608800888,
-0.0350162573158741,
-0.008714525029063225,
0.04226798191666603,
0.06995085626840591,
-0.033302176743745804,
-0.062167275696992874,
-0.015928583219647408,
0.... | 0.033425 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.