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/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 |
percent-encode `[` as `%5B` and `]` 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 | | -------------- | ------------------------------------------------------------... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/feature-sets.mdx | main | terraform | [
-0.020663950592279434,
0.0708073303103447,
-0.04660896584391594,
0.003077967558056116,
-0.08968754857778549,
0.024421537294983864,
-0.03487015515565872,
-0.032130125910043716,
-0.022098571062088013,
0.014143240638077259,
0.019180020317435265,
-0.08430337905883789,
0.08673025667667389,
-0.0... | -0.018875 |
[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 [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.03997606784105301,
0.0039308033883571625,
0.011174616403877735,
0.08739098161458969,
0.0296368096023798,
-0.036456942558288574,
0.013098511844873428,
-0.17083829641342163,
0.019664259627461433,
0.0764765664935112,
0.03602384403347969,
-0.01701122708618641,
0.058875154703855515,
0.058537... | -0.03104 |
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 |
application/vnd.api+json" \ https://app.terraform.io/api/v2/workspaces/ws-yF7z4gyEQRhaCNG9/runs ``` ### Sample Response ```json { "data": [ { "id": "run-CZcmD7eagjhyX0vN", "type": "runs", "attributes": { "actions": { "is-cancelable": true, "is-confirmable": false, "is-discardable": false, "is-force-cancelable": false }... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/run.mdx | main | terraform | [
-0.0737210363149643,
0.056821584701538086,
0.048036377876996994,
0.04723508656024933,
0.026710741221904755,
-0.05344396084547043,
-0.064341701567173,
-0.06078460440039635,
0.0641542300581932,
0.10722304880619049,
0.000027180425604456104,
-0.0720139741897583,
-0.010263086296617985,
0.025869... | 0.035165 |
| Optional | | `search[user]` | Searches for runs that match the VCS username you supply. | Optional | | `search[commit]` | Searches for runs that match the commit sha you specify. | Optional | | `search[basic]` | Searches for runs that match the VCS username, commit sha, run\_id, or run message your specify. HCP Terra... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/run.mdx | main | terraform | [
0.016573794186115265,
0.10506654530763626,
0.03396983444690704,
-0.0021799765527248383,
-0.025519954040646553,
0.014071800746023655,
-0.030292624607682228,
-0.013192241080105305,
0.03954148292541504,
0.02764599211513996,
0.00009338904055766761,
-0.13487309217453003,
0.023924998939037323,
-... | 0.027165 |
does not return any object in the response body. -> \*\*Note:\*\* This endpoint cannot be accessed 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-tokens) or [... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/run.mdx | main | terraform | [
-0.011551940813660622,
0.08425986021757126,
0.04692317172884941,
0.02366669476032257,
-0.001491251401603222,
-0.06091998517513275,
-0.041057832539081573,
-0.03440907225012779,
0.08225953578948975,
0.08251512795686722,
-0.04070225730538368,
-0.10541194677352905,
-0.024208709597587585,
0.017... | 0.048816 |
operation requires admin access to the workspace. ([More about permissions.](/terraform/cloud-docs/users-teams-organizations/permissions)) [permissions-citation]: #intentionally-unused---keep-for-maintainers This endpoint enforces a prerequisite that a [non-forceful cancel](#cancel-a-run) is performed first, and a cool... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/run.mdx | main | terraform | [
-0.02154684253036976,
0.045105453580617905,
0.053270597010850906,
0.08437585830688477,
0.007974756881594658,
-0.0656186193227768,
0.00022304360754787922,
-0.14861942827701569,
0.10404979437589645,
0.13060766458511353,
-0.003746452508494258,
0.003128020791336894,
0.011667399667203426,
-0.03... | 0.017034 |
API error object][] | Run is not pending, its workspace was not locked, or its workspace association was not found. | | [409][] | [JSON API error object][] | The run locking the workspace was not in a discardable state. | | [404][] | [JSON API error object][] | Run was not found or user not authorized. | ### Request Bo... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/run.mdx | main | terraform | [
-0.06680329144001007,
0.03683210164308548,
-0.007753144484013319,
0.02543504349887371,
0.010597540996968746,
-0.024394184350967407,
-0.05266442149877548,
-0.1117415502667427,
0.05100332200527191,
0.0738743245601654,
-0.011866665445268154,
-0.033864956349134445,
0.0010634340578690171,
0.050... | 0.066481 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [307]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/states.mdx | main | terraform | [
-0.026010459288954735,
-0.02275005355477333,
-0.026095468550920486,
-0.018418513238430023,
-0.02009897492825985,
-0.08436909317970276,
-0.05374377593398094,
-0.0791759043931961,
-0.0060250526294112206,
-0.03486490249633789,
0.03005075827240944,
0.05508139356970787,
0.0022271922789514065,
-... | 0.068675 |
[204][] | No Content | Responds with empty success when state has not yet been uploaded. | | [307][] | [JSON API error object][] | Redirect client to temporary Stack state description download URL. | | [404][] | [JSON API error object][] | Stack state not found, or user unauthorized to perform action. | ### Sample Requ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/states.mdx | main | terraform | [
-0.0192185677587986,
0.018051479011774063,
0.015383063815534115,
0.00996266957372427,
0.015875408425927162,
-0.08057822287082672,
-0.08015871047973633,
-0.0416213721036911,
0.07170674204826355,
0.0988309308886528,
0.02067180909216404,
-0.09752675145864487,
0.014656554907560349,
0.038047194... | 0.068925 |
[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/stacks/index.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
a Stack configuration when this value is present and a VCS event occurs that contains a matching Git tag for the regular expression. | | `data.attributes.vcs-repo.identifier` | string | | A reference to your VCS repository in the format `:org/:repo` where `:org` and `:repo` refer to the organization and repository in y... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/index.mdx | main | terraform | [
-0.021849194541573524,
-0.040502388030290604,
-0.0328083299100399,
0.049267515540122986,
0.0009060148731805384,
0.013129844330251217,
0.01940673403441906,
0.003006831044331193,
0.1301112323999405,
0.07681713253259659,
0.007161956280469894,
-0.07428521662950516,
0.04335547611117363,
-0.0289... | 0.031064 |
| \*\*Optional.\*\* Allows sorting the returned Stacks. Valid values are "name" and "updated-at". Prepending a hyphen to the sort parameter reverses the order. For example, `"-name"` sorts by name in reverse alphabetical order. If omitted, the default sort order is arbitrary but stable. | ### Available Related Resource... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/index.mdx | main | terraform | [
-0.021970268338918686,
0.05846616253256798,
0.07174093276262283,
0.03202075511217117,
-0.01596369594335556,
-0.0051878965459764,
-0.015440813265740871,
-0.0844602957367897,
0.07071128487586975,
0.09646838903427124,
0.006319936830550432,
-0.02170952782034874,
0.042261019349098206,
0.0128211... | -0.019028 |
If omitted, the endpoint will return the first page. | | `page[size]` | \*\*Optional.\*\* If omitted, the endpoint will return 20 Stack configuration summaries per page. | ### Sample Request ```shell $ curl\ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ https://app.terraf... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/index.mdx | main | terraform | [
-0.03158203512430191,
0.08911986649036407,
0.02036047726869583,
0.04373900592327118,
-0.003127726726233959,
-0.020334111526608467,
-0.071316659450531,
-0.04151583090424538,
0.07924595475196838,
0.0697689801454544,
0.021619999781250954,
-0.09351478517055511,
0.013237334787845612,
-0.0367519... | 0.02562 |
| `data.attributes.vcs-repo.oauth-token-id` | string | | The VCS Connection (OAuth Connection + Token) to use. This ID can be obtained from the [oauth-tokens](/terraform/cloud-docs/api-docs/oauth-tokens) endpoint. | | `data.relationships.project.data.id` | string | | The ID of the project to create the Stack in. You mu... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/index.mdx | main | terraform | [
-0.04797353968024254,
0.001211029477417469,
-0.033941660076379776,
0.019530130550265312,
-0.03471213951706886,
-0.07115517556667328,
-0.03221355006098747,
-0.013667833991348743,
0.1007518321275711,
0.04395141825079918,
-0.013900954276323318,
-0.0967877134680748,
0.039631009101867676,
0.021... | 0.013285 |
[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/stacks/deployments.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 |
{ "data": { "id": "st-MWvJsvy1FCg3bnXY", "type": "stacks" } }, "latest-deployment-run": { "data": { "id": "sdr-vzub48Y4f7sFBk7J", "type": "stack-deployment-runs" } } }, "links": { "self": "/api/v2/stacks/st-MWvJsvy1FCg3bnXY/stack-deployments/simple", "stack-deployment-runs": "/api/v2/stacks/st-MWvJsvy1FCg3bnXY/stack-de... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/deployments.mdx | main | terraform | [
-0.033427342772483826,
0.013079417869448662,
0.04477215185761452,
0.024791233241558075,
0.019060594961047173,
-0.060525622218847275,
-0.11516764014959335,
-0.02746407687664032,
0.01572139374911785,
0.052792809903621674,
0.024391431361436844,
-0.06426054984331131,
0.0076888431794941425,
-0.... | -0.072905 |
{ "self": "/api/v2/stack-deployment-groups/sdg-f5GVSZb7HxQ5aWG7", "stack-deployment-group-summaries": "/api/v2/stack-configurations/stc-d7w6uC1QEB6fqWjW/stack-deployment-group-summaries" } } } ``` ## List Stack deployment runs in a configuration This endpoint lists Stack deployment runs for a Stack configuration. `GET ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/deployments.mdx | main | terraform | [
0.0007495296886190772,
0.017729436978697777,
-0.02581137791275978,
0.04223761335015297,
-0.02514774724841118,
-0.03680020570755005,
-0.040565650910139084,
0.026915600523352623,
0.01537454966455698,
-0.018271036446094513,
0.059599947184324265,
-0.08285902440547943,
-0.038861408829689026,
-0... | 0.053316 |
The configuration that last referenced a deployment that has been omitted in the configuration that contains the specified run. | | `blocked\_by\_deployment\_group` | The deployment group that is blocking this run from proceeding. | ### Sample Request ```shell $ curl\ --header "Authorization: Bearer $TOKEN" \ --header ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/deployments.mdx | main | terraform | [
-0.018371393904089928,
0.013492131605744362,
0.03747321665287018,
0.007336371578276157,
-0.003423896851018071,
-0.0882616862654686,
-0.07629972696304321,
-0.08768640458583832,
0.05147455632686615,
0.11436714231967926,
0.027020514011383057,
-0.0697750598192215,
-0.00969418790191412,
-0.0134... | -0.027433 |
`page[number]` | \*\*Optional.\*\* If omitted, the endpoint will return the first page. | | `page[size]` | \*\*Optional.\*\* If omitted, the endpoint will return 20 Stack deployment steps runs per page. | ### Available Related Resources This GET endpoint can optionally return related resources, if requested with [the `... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/deployments.mdx | main | terraform | [
-0.04164831340312958,
0.060972925275564194,
0.04590312018990517,
0.03785692900419235,
0.011188975535333157,
-0.019637493416666985,
-0.03613770753145218,
-0.09487874805927277,
0.052096523344516754,
0.0635557547211647,
0.027478119358420372,
-0.06368532031774521,
0.04444525018334389,
-0.05158... | 0.009666 |
| \*\*Optional.\*\* If omitted, the endpoint will return 20 Stack deployment step diagnostics per page. | ### Sample Request ```shell $ curl\ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ https://app.terraform.io/api/v2/stack-deployment-steps/sds-LSqektntTNJrAhCt/stack-di... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/deployments.mdx | main | terraform | [
0.0033058100380003452,
0.09180372953414917,
0.03679852932691574,
0.012402829714119434,
-0.0031088385730981827,
-0.03788599371910095,
-0.050375036895275116,
-0.04129372164607048,
0.0526190921664238,
0.0780276358127594,
0.006236318964511156,
-0.13895998895168304,
0.055784668773412704,
-0.028... | 0.000805 |
reruns a Stack deployment group that has ended up in a failed state. `POST /stack-deployment-groups/:stack\_deployment\_group\_id/rerun` | Parameter | Description | |------------------------------|-----------------------------------------| | `:stack\_deployment\_group\_id` | The Stack deployment group id to rerun. | | ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/deployments.mdx | main | terraform | [
-0.00003786647357628681,
-0.03953249007463455,
0.03509864956140518,
0.053958382457494736,
-0.022777728736400604,
-0.06041065230965614,
-0.05303866043686867,
-0.0718710720539093,
-0.01828933134675026,
-0.01576690562069416,
0.05497003719210625,
-0.04554181173443794,
0.000463260366814211,
-0.... | -0.001761 |
string | "" | The reason for the advancement | ### Sample Request ```shell $ curl\ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ https://app.terraform.io/api/v2/stack-deployment-steps/sds-LSqektntTNJrAhCt/advance ``` | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/deployments.mdx | main | terraform | [
0.00740836514160037,
0.09591355174779892,
-0.02168409898877144,
-0.02844487503170967,
-0.009859980084002018,
-0.01387088280171156,
-0.009014762938022614,
0.012825394049286842,
0.034069087356328964,
0.08241264522075653,
-0.0014611049555242062,
-0.0855642631649971,
0.012713436968624592,
-0.0... | 0.068696 |
[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 [302]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302 [204]: 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/stacks/configurations.mdx | main | terraform | [
-0.022840997204184532,
-0.01981019228696823,
-0.029182204976677895,
-0.013868125155568123,
-0.018806852400302887,
-0.0860305055975914,
-0.05282869562506676,
-0.0755099505186081,
-0.0026346701197326183,
-0.036433931440114975,
0.028786011040210724,
0.05538564175367355,
-0.0026604565791785717,
... | 0.06642 |
branch. `POST /stacks/:stack\_id/fetch-latest-from-vcs` | Parameter | Description | |-------------|--------------------------------------------------| | `:stack\_id` | The target Stack ID to fetch a configuration for.| | Status | Response | Reason | |---------|---------------------------|-------------------------------... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/configurations.mdx | main | terraform | [
0.003995544742792845,
-0.008666750974953175,
-0.06306364387273788,
0.04166622832417488,
-0.029035404324531555,
-0.048087481409311295,
-0.058487419039011,
0.023095067590475082,
-0.002506880322471261,
-0.0070185367949306965,
0.048515547066926956,
-0.08300327509641647,
0.014272832311689854,
-... | 0.035299 |
| `:stack\_configuration\_id` | The Stack configuration id to list the deployment group summaries for. | ### Query Parameters This endpoint supports pagination [with standard URL query parameters](/terraform/cloud-docs/api-docs#query-parameters); remember to percent-encode `[` as `%5B` and `]` as `%5D` if your tooling ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/configurations.mdx | main | terraform | [
-0.008192229084670544,
0.041731953620910645,
0.034201834350824356,
0.014289133250713348,
-0.06114717200398445,
0.020635336637496948,
-0.06238487735390663,
-0.09309320151805878,
0.045308828353881836,
0.08484864234924316,
-0.012405982241034508,
-0.09918974339962006,
0.06809787452220917,
-0.0... | -0.02946 |
"/api/v2/stack-configurations/stc-SihZTyXKfNXUWuUa/upload-url" } } ``` ## Fetch Stack configuration source bundle `GET /stack-configurations/:stack\_configuration\_id/source-bundle` This endpoint redirects to the download URL for a Stack configuration source bundle. | Parameter | Description | |------------------------... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/configurations.mdx | main | terraform | [
-0.04257899522781372,
-0.007248526439070702,
-0.06837517023086548,
0.04460018873214722,
0.0331493616104126,
-0.0036382025573402643,
-0.025964248925447464,
0.057217564433813095,
0.014409518800675869,
0.020786330103874207,
0.03126698359847069,
-0.06165418028831482,
-0.014545539394021034,
-0.... | 0.005013 |
[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/private-registry/tests.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 |
is being created. | A test run executes tests against a registry module, using a configuration version and the modules’s current environment variables. Creating a test run requires permission to access the specified module. Refer to [Permissions](/terraform/cloud-docs/users-teams-organizations/permissions) for more inf... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/tests.mdx | main | terraform | [
0.012591413222253323,
0.053044553846120834,
-0.027871351689100266,
0.025625040754675865,
-0.05495351925492287,
-0.021421533077955246,
-0.025752851739525795,
-0.05323559418320656,
0.03412947431206703,
0.04965856298804283,
0.01567383110523224,
-0.06081417202949524,
0.05095944553613663,
0.050... | -0.006433 |
--header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request POST \ https://app.terraform.io/api/v2/organizations/my-organization/tests/registry-modules/private/my-organization/registry-name/registry-provider/test-runs/configuration-versions ``` ### Sample Response ```json { "... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/tests.mdx | main | terraform | [
-0.0722401961684227,
0.06683891266584396,
-0.019378570839762688,
0.027258332818746567,
-0.01949192024767399,
-0.04750040918588638,
-0.038419678807258606,
-0.03096557967364788,
0.0313195139169693,
0.11986584216356277,
0.009137262590229511,
-0.1160607561469078,
0.014456087723374367,
0.055653... | 0.057598 |
as the `:organization\_name` parameter. | | `:name` | The name of the module which the test was executed against. | | `:provider` | The name of the provider which the test was executed against. | | `:test\_run\_id` | The test ID to get. | ### Sample Request ```shell curl \ --header "Authorization: Bearer $TOKEN" \ --he... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/tests.mdx | main | terraform | [
-0.033429913222789764,
0.09602788090705872,
-0.044897280633449554,
0.0534590408205986,
-0.016162646934390068,
-0.060642778873443604,
-0.03749072551727295,
-0.036144815385341644,
0.03644502907991409,
0.07081373780965805,
0.02057075686752796,
-0.08832453936338425,
-0.00855475664138794,
0.028... | 0.046962 |
terminates the running Terraform process. ~> \*\*Warning:\*\* This endpoint has potentially dangerous side-effects, including loss of any in-flight state in the running Terraform process. Use this operation with extreme caution. | Status | Response | Reason(s) | | ------- | ------------------------- | -----------------... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/tests.mdx | main | terraform | [
-0.06001880392432213,
0.09657802432775497,
0.018367402255535126,
-0.011117789894342422,
0.007878310978412628,
-0.08372847735881805,
-0.04435012489557266,
-0.08235783129930496,
0.05693595111370087,
0.09600526094436646,
-0.013695581816136837,
-0.0259874165058136,
0.009134471416473389,
-0.024... | 0.066114 |
| The name of the module which the test environment variables were created for. | | `:provider` | The name of the provider which the test environment variables were created for. | ### Sample Request ```shell $ curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ https://a... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/tests.mdx | main | terraform | [
-0.01058156881481409,
0.05324297770857811,
-0.016001034528017044,
0.0411204919219017,
-0.014444367028772831,
-0.03877606987953186,
-0.020032422617077827,
-0.021756725385785103,
0.02859107404947281,
0.06632467359304428,
0.0186880175024271,
-0.1134919747710228,
0.03340936824679375,
0.0417765... | -0.010917 |
[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/private-registry/manage-module-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 |
module belongs to. | | `:module\_name` | The name of the module you want to revert the deprecation of. | | `:module\_provider` | Specifies the Terraform provider that this module uses. | | `:module\_version` | The module version you want to revert the deprecation of. | Deprecating a module version adds warnings to the ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/manage-module-versions.mdx | main | terraform | [
-0.05346827208995819,
0.07232768833637238,
0.07533719390630722,
0.01362062431871891,
0.03913160786032677,
-0.024951014667749405,
-0.0684056505560875,
-0.060798853635787964,
0.021696168929338455,
0.05073844641447067,
0.020082658156752586,
0.03135380148887634,
0.02756020426750183,
-0.0098578... | 0.00873 |
name of the organization the module belongs to. | | `:module\_name` | The name of the module whose version you want to revoke. | | `:module\_provider` | Specifies the Terraform provider that this module uses. | | `:module\_version` | The module version you want to revoke. | This endpoint allows you to revoke a specific... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/manage-module-versions.mdx | main | terraform | [
-0.047362320125103,
0.10671645402908325,
0.0652599036693573,
0.007128585129976273,
0.027496155351400375,
-0.03676353767514229,
-0.03113819845020771,
-0.09923709183931351,
0.06055837497115135,
0.05155932158231735,
0.008171744644641876,
0.042422305792570114,
0.0429125539958477,
0.00849906541... | 0.03245 |
PATCH \ --data @payload.json \ https://app.terraform.io/api/v2/organizations/hashicorp/registry-modules/private/hashicorp/lb-http/google/11.0.0 ``` ### Sample payload ```json { "data": { "type": "module-versions", "attributes": { "revocation": { "status": "Unrevoked" } } } } ``` ### Sample Response ```json { "data": { ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/manage-module-versions.mdx | main | terraform | [
-0.03067539446055889,
0.05373343825340271,
0.051711149513721466,
-0.03967601805925369,
-0.028051238507032394,
-0.045564115047454834,
-0.06136876717209816,
-0.050966423004865646,
0.010376140475273132,
0.07758434116840363,
0.02499924972653389,
-0.09823063760995865,
-0.0063725607469677925,
-0... | 0.039047 |
[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/private-registry/stack-component-configurations.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 |
1, "page-size": 20, "prev-page": null, "next-page": null, "total-pages": 1, "total-count": 2 } } } ``` ## Create a Stack component configuration `POST /organizations/:organization\_name/registry-components` | Parameter | Description | | -------------------- | ------------------------------------------------------------... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/stack-component-configurations.mdx | main | terraform | [
-0.02154497243463993,
-0.0002994627575390041,
-0.05327973887324333,
0.05290580913424492,
-0.1205032616853714,
0.05208608880639076,
-0.05607445165514946,
0.06207283213734627,
-0.009527812711894512,
0.020755618810653687,
0.05674978345632553,
-0.05014368146657944,
0.018124358728528023,
-0.063... | 0.038273 |
Data Center, use the syntax `:project\_key/:repo`. If you are using Azure DevOps, use the syntax `:org/:project/\_git/:repo`. The OAuth token ID identifies the VCS connection, and therefore the organization, that HCP Terraform creates the component configuration in. #### Sample payload The following example payload sou... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/stack-component-configurations.mdx | main | terraform | [
-0.0014749841066077352,
-0.004111467860639095,
-0.029420722275972366,
0.013219393789768219,
-0.034395359456539154,
0.044599030166864395,
0.0031413757242262363,
-0.012683669105172157,
0.0517616793513298,
0.05805390700697899,
-0.02665874920785427,
-0.09336506575345993,
0.10063061863183975,
-... | 0.032335 |
subsequent configurations to the link that HCP Terraform returns. | Status | Response | Reason | | ------- | --------------------------------------------------------------------- | -------------------------------------------------------------- | | [201][] | [JSON API document][] (`type: "registry-component-versions"`) ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/stack-component-configurations.mdx | main | terraform | [
-0.06238982081413269,
0.06160818785429001,
0.03816867619752884,
-0.0038139887619763613,
0.0015690902946516871,
-0.02973945438861847,
-0.04591360688209534,
-0.057449664920568466,
-0.03300342336297035,
0.007177738938480616,
0.015424888581037521,
-0.0986514464020729,
0.041075997054576874,
0.0... | 0.010834 |
action. | ### Sample request The following example request gets details about a Stack component configuration: ```shell curl \ --request GET \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ https://app.terraform.io/api/v2/registry-components/comp-7GjfsTX1Yc5E1boD ``` ### S... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/stack-component-configurations.mdx | main | terraform | [
-0.035544153302907944,
0.04547751694917679,
0.010856551118195057,
0.038489971309900284,
-0.00487350020557642,
-0.08507425338029861,
-0.06388378143310547,
-0.03659786283969879,
0.05796271562576294,
0.08797761052846909,
0.018393663689494133,
-0.05152427405118942,
-0.016128486022353172,
0.012... | 0.013504 |
[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/private-registry/gpg-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 |
User not authorized | ### Request Body This POST endpoint requires a JSON object with the following properties as a request payload. Properties without a default value are required. | Key path | Type | Default | Description | | ----------------------------- | ------ | ------- | -----------------------------------------... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/gpg-keys.mdx | main | terraform | [
-0.042757704854011536,
0.05439895763993263,
-0.04626915603876114,
0.03286312147974968,
-0.0924292802810669,
-0.07467033714056015,
0.05397510901093483,
0.013652256689965725,
-0.023888085037469864,
-0.004729119129478931,
-0.0038259802386164665,
-0.08396323770284653,
0.019832992926239967,
0.0... | -0.060811 |
Key path | Type | Default | Description | | ----------------------------- | ------ | ------- | -------------------------------------------------------------------------------------------- | | `data.type` | string | | Must be `"gpg-keys"`. | | `data.attributes.namespace` | string | | The namespace of the provider. Must ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/gpg-keys.mdx | main | terraform | [
-0.05092944577336311,
0.025871440768241882,
-0.005484056193381548,
0.05917933210730553,
-0.023607483133673668,
-0.05323881283402443,
0.04138839244842529,
0.02010604925453663,
0.0008283553179353476,
-0.01629030331969261,
-0.02879074029624462,
-0.059272415935993195,
-0.013685262762010098,
0.... | -0.070512 |
[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/private-registry/providers.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 |
and private providers: - \*\*Public providers:\*\* The public provider record will be available in the organization's registry provider list immediately after creation. You cannot create versions for public providers; you must use the versions available on the Terraform Registry. - \*\*Private providers:\*\* The privat... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/providers.mdx | main | terraform | [
-0.009183889254927635,
-0.0242206621915102,
0.04980194941163063,
-0.002431065309792757,
0.0016022780910134315,
0.016301099210977554,
-0.060574065893888474,
-0.0726989209651947,
0.0440434031188488,
0.12367960810661316,
0.04159153252840042,
-0.01298565324395895,
0.012970716692507267,
-0.0179... | -0.044805 |
## Get a Provider `GET /organizations/:organization\_name/registry-providers/:registry\_name/:namespace/:name` ### Parameters | Parameter | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------ | | `:organization\_name` | The ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/providers.mdx | main | terraform | [
-0.06471081078052521,
-0.0073589966632425785,
-0.1070750430226326,
0.04247688129544258,
-0.027225874364376068,
-0.02243715710937977,
0.07587455213069916,
-0.026999561116099358,
-0.0290813185274601,
0.0010091278236359358,
0.07127964496612549,
-0.07576795667409897,
-0.02140253409743309,
-0.0... | 0.025005 |
[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/private-registry/modules.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 |
searchable by name, namespace, provider fields. | | `filter[field name]` | \*\*Optional.\*\* If specified, restricts results to those with the matching field name value. Valid values are `registry\_name`, `provider`, and `organization\_name`. | | `page[number]` | \*\*Optional.\*\* If omitted, the endpoint will return t... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/modules.mdx | main | terraform | [
-0.0613325797021389,
0.09886891394853592,
-0.013830442912876606,
0.029491087421774864,
0.005952106788754463,
-0.01959887705743313,
-0.025746138766407967,
-0.05825258791446686,
0.02345210500061512,
0.04517090693116188,
0.0012354818172752857,
-0.07151465862989426,
0.04193819314241409,
0.0242... | 0.031299 |
not specify this value if `github-app-installation-id` is specified. | | `data.attributes.vcs-repo.github-app-installation-id` | string | | The VCS Connection GitHub App Installation to use. Find this ID on the account settings page. Requires previously authorizing the GitHub App and generating a user-to-server token. ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/modules.mdx | main | terraform | [
-0.006133835297077894,
0.030963314697146416,
-0.020847581326961517,
0.009514519944787025,
-0.0075816684402525425,
-0.004512184299528599,
0.022985154762864113,
-0.01945924200117588,
0.05213883891701698,
0.03886621072888374,
0.004734502639621496,
-0.0978304073214531,
0.08754399418830872,
-0.... | -0.025765 |
create and upload each new version with the [Create a Module Version](#create-a-module-version) endpoint. #### Public modules When created, the public module record will be available in the organization's registry module list. You cannot create versions for public modules as they are maintained in the public registry. ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/modules.mdx | main | terraform | [
-0.03734423965215683,
-0.011018007062375546,
-0.07692604511976242,
0.007557624485343695,
-0.01003614068031311,
-0.011579993180930614,
-0.1143227368593216,
0.015652641654014587,
-0.03063410334289074,
0.02586614340543747,
0.07024423032999039,
-0.019561832770705223,
-0.01044212281703949,
0.02... | 0.023634 |
| The name of the organization to create a module in. The organization must already exist, and the token authenticating the API request must belong to a team or team member with the \*\*Manage modules\*\* permission enabled. | | `:namespace` | The namespace of the module for which the version is being created. For priv... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/modules.mdx | main | terraform | [
-0.08241786062717438,
-0.026196090504527092,
-0.08087543398141861,
-0.027147231623530388,
0.021801983937621117,
-0.013229449279606342,
-0.046059031039476395,
-0.019701756536960602,
0.01035536639392376,
0.022641971707344055,
0.045601729303598404,
-0.09668511152267456,
0.030987048521637917,
... | 0.056258 |
its status will become `"ok"`. ## Get a Module ~> \*\*Deprecation warning\*\*: the following endpoint `GET /registry-modules/show/:organization\_name/:name/:provider` is replaced by the below endpoint and will be removed from future versions of the API! `GET /organizations/:organization\_name/registry-modules/:registry... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/modules.mdx | main | terraform | [
-0.06689730286598206,
0.0455697737634182,
-0.07538898289203644,
0.04856380447745323,
-0.030131135135889053,
-0.027490787208080292,
-0.015993662178516388,
-0.02523256652057171,
-0.03062291070818901,
-0.04944973438978195,
0.06330056488513947,
-0.02008737437427044,
-0.039825115352869034,
0.01... | 0.113197 |
| (previous value) | Whether the registry module should be tag-based. This cannot be used with the `data.attributes.vcs-repo.branch` key. | | `data.attributes.test-config.tests-enabled` | boolean | (previous value) | Allows you to enable or disable tests for the module. | | `data.attributes.test-config.agent-execution-... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/modules.mdx | main | terraform | [
0.006947299465537071,
0.00765312509611249,
-0.07699647545814514,
0.04629913344979286,
-0.003223886713385582,
0.014113969169557095,
-0.008997173048555851,
0.014746921136975288,
-0.03773171827197075,
0.014880015514791012,
0.07618840783834457,
-0.013304615393280983,
-0.00835825689136982,
0.05... | 0.035291 |
organization's HCP Terraform Registry and does not remove the public module from registry.terraform.io. If a version deletion would leave a provider with no versions, the provider will be deleted. If a provider deletion would leave a module with no providers, the module will be deleted. | Status | Response | Reason | |... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/modules.mdx | main | terraform | [
-0.04345880076289177,
0.04967889562249184,
-0.021505961194634438,
-0.03292195498943329,
0.02985520474612713,
-0.014026407152414322,
-0.055769890546798706,
-0.1198410913348198,
0.035239044576883316,
0.022093702107667923,
0.062824547290802,
0.0004483992524910718,
0.01027392502874136,
-0.0169... | 0.021254 |
[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/private-registry/provider-versions-platforms.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.