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 |
|---|---|---|---|---|---|
store "varset" "secrets" { name = "Database passwords" category = "terraform" } ``` Your Stack deployments can directly reference variable values using `store.varset..` syntax. In the following example, the deployment uses the `db\_password` variable to configure the `production` deployment: ```hcl store "varset" "secr... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/variables/managing-variables.mdx | main | terraform | [
-0.02217639610171318,
-0.023530784994363785,
-0.020758692175149918,
0.04417413845658302,
-0.10039236396551132,
-0.0025913601275533438,
0.02694818377494812,
-0.061640020459890366,
0.056182511150836945,
0.03482215479016304,
0.03270885720849037,
-0.06389057636260986,
0.0870831087231636,
-0.06... | -0.026777 |
state, it can include them in log files if `TF\_LOG` is set to `TRACE`. #### Dynamic credentials An alternative to passing static credentials for some providers is to use [dynamic credentials](/terraform/cloud-docs/dynamic-provider-credentials). Dynamic credentials allows for using temporary per-run credentials and eli... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/variables/managing-variables.mdx | main | terraform | [
-0.001947773969732225,
0.011408114805817604,
-0.03784200921654701,
-0.005460245069116354,
-0.06106949597597122,
-0.028765074908733368,
0.031913865357637405,
-0.035471074283123016,
0.03275235742330551,
0.014541571959853172,
-0.013956820592284203,
-0.07589525729417801,
0.07044214010238647,
-... | 0.026645 |
# HCP Terraform private registry overview HCP Terraform's private registry works similarly to the [public Terraform Registry](/terraform/registry) and helps you share [Terraform providers](/terraform/language/providers) and [Terraform modules](/terraform/language/modules) across your organization. It includes support f... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/index.mdx | main | terraform | [
-0.016969328746199608,
-0.04199274629354477,
-0.020936068147420883,
-0.02157491259276867,
0.025375572964549065,
0.04227201268076897,
-0.028312234207987785,
-0.060091663151979446,
-0.009775454178452492,
0.023013433441519737,
0.006718916352838278,
-0.05912886932492256,
0.023772217333316803,
... | 0.07971 |
# Manage module versions You can manage the lifecycle of module versions in your organization’s private registry by deprecating or revoking module versions as you stop maintaining and supporting those versions. @include "tfc-package-callouts/manage-module-versions.mdx" Deprecating a module version adds warnings to the ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/manage-module-versions.mdx | main | terraform | [
0.016200266778469086,
0.05007157474756241,
0.05099879205226898,
-0.027850758284330368,
0.04196850582957268,
-0.00019479783077258617,
-0.039609815925359726,
-0.07185486704111099,
0.013377057388424873,
0.03114054538309574,
0.011083021759986877,
0.010386263951659203,
0.013522496446967125,
-0.... | -0.011518 |
continue supporting. ### Deprecation warnings After you deprecate a module version, consumers of that version receive warnings in their operation outputs urging them to update that version in both HCP Terraform and the Terraform CLI. ~> \*\*Note\*\*: Only workspaces in the [remote or agent execution modes](/terraform/c... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/manage-module-versions.mdx | main | terraform | [
-0.007648382801562548,
0.03159286454319954,
0.08275159448385239,
0.020202068611979485,
0.03202934190630913,
-0.006728473585098982,
-0.052724163979291916,
-0.07293190807104111,
-0.016399383544921875,
0.0388324074447155,
-0.0066978419199585915,
-0.05415366590023041,
0.05180772393941879,
-0.0... | -0.008579 |
used module version. Module version X.X.X of is revoked. ``` A run’s output mode affects where a version's revocation warnings appear. If a workspace is in the default [\*\*Structured Run Output\*\*](/terraform/cloud-docs/workspaces/settings#user-interface) mode, then module revocation warnings show up under a run’s \*... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/manage-module-versions.mdx | main | terraform | [
-0.0215216763317585,
0.026216527447104454,
0.059626612812280655,
0.021549006924033165,
0.026735324412584305,
-0.04090069606900215,
-0.019980860874056816,
-0.0911598727107048,
0.06122562289237976,
0.018084600567817688,
0.0200334619730711,
0.04735797643661499,
0.03596486151218414,
-0.0044330... | 0.00059 |
[vcs]: /terraform/cloud-docs/vcs # Publish private modules to the private registry This topic describes how to publish private modules to an organization's private registry. For instructions on adding modules from the public registry, refer to [Add modules from the Terraform registry](/terraform/cloud-docs/registry/add... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/publish-modules.mdx | main | terraform | [
-0.033886250108480453,
-0.03382578864693642,
-0.04269443824887276,
0.027946704998612404,
0.02055446244776249,
0.019247058779001236,
-0.03296203911304474,
-0.029425015673041344,
0.039557069540023804,
0.06984959542751312,
0.04597879573702812,
-0.03625723719596863,
0.02562740631401539,
-0.012... | 0.036548 |
option in your organization settings. When disabled, you should store the source code for each module in separate repositories, otherwise HCP Terraform and Terraform Enterprise may publish new versions of all modules in the repository each time you create a new release tag. ## Publish a new module You can publish modul... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/publish-modules.mdx | main | terraform | [
-0.00273302779532969,
-0.051420796662569046,
-0.03664948046207428,
0.02195633016526699,
0.005589573178440332,
0.026495305821299553,
-0.10969166457653046,
-0.06746458262205124,
0.027887117117643356,
0.09126319736242294,
0.01612616330385208,
-0.026637578383088112,
0.05390439182519913,
-0.040... | 0.001528 |
tags to identify module versions. Your repository must contain at least one release tag for you to publish a module. Release tag names must be a [semantic version](http://semver.org), which you can optionally prefix with a `v`. For example, `v1.0.4` and `0.9.2`. The registry ignores tags that do not match these formats... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/publish-modules.mdx | main | terraform | [
0.01823953539133072,
-0.04553361237049103,
0.007699673064053059,
-0.0020425422117114067,
0.005968845449388027,
-0.003168324241414666,
-0.05901763588190079,
-0.04068687558174133,
-0.01361026056110859,
0.0509004145860672,
0.05598876252770424,
-0.06266318261623383,
0.039333514869213104,
-0.02... | -0.00635 |
repos named `terraform-aws-appserver` and `terraform-azure-appserver`, the registry treats them as alternate providers of the same `appserver` module. - \*\*Delete all providers and versions for this module:\*\* Deletes all modules with this name, even if they are from different providers. For example, this action dele... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/publish-modules.mdx | main | terraform | [
-0.08596344292163849,
-0.06420252472162247,
-0.028994359076023102,
-0.018769266083836555,
0.05155263841152191,
0.012677262537181377,
-0.009008422493934631,
-0.13359205424785614,
0.046858880668878555,
0.03840264305472374,
0.06364504247903824,
0.004657624755054712,
0.066465362906456,
0.03300... | -0.000033 |
# Use the configuration designer HCP Terraform's private registry includes a configuration designer that can help you spend less time writing boilerplate code in a module-centric Terraform workflow. The configuration designer lets you outline a configuration for a new workspace by choosing any number of private modules... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/design.mdx | main | terraform | [
-0.04051299765706062,
0.024049261584877968,
-0.021221531555056572,
0.013179420493543148,
0.005626922473311424,
-0.00761213107034564,
-0.05981694161891937,
-0.0389319472014904,
-0.041828300803899765,
0.08039737492799759,
-0.03994804620742798,
-0.06596031039953232,
0.07428555935621262,
-0.04... | 0.066503 |
HCP Terraform does not save output from previous configuration designer runs. | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/design.mdx | main | terraform | [
0.04404082149267197,
0.055124878883361816,
0.016705114394426346,
0.007703529205173254,
0.009097657166421413,
0.02246668189764023,
-0.09167511761188507,
-0.09408906102180481,
-0.04142322018742561,
0.03636155277490616,
-0.030526177957654,
-0.07122088223695755,
0.06202815845608711,
-0.0680595... | -0.079019 |
# Publish private providers to the HCP Terraform private registry In addition to [curating public providers from the Terraform Registry](/terraform/cloud-docs/registry/add), you can publish private providers to an organization's HCP Terraform private registry. Once you have published a private provider through the API,... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/publish-providers.mdx | main | terraform | [
-0.012579026632010937,
-0.011255146004259586,
-0.027422374114394188,
0.005256079137325287,
-0.025465218350291252,
0.017776433378458023,
-0.0272675808519125,
-0.05251257121562958,
-0.017714552581310272,
0.07499814033508301,
0.011839437298476696,
-0.05273284390568733,
0.04577906057238579,
0.... | 0.019267 |
and instead use [HashiCorp's public PGP key](https://www.hashicorp.com/.well-known/pgp-key.txt) in the the [create a version](#create-a-version) step. The key ID for HashiCorp's public ID is `34365D9472D7468F`, and you can verify the ID by [importing the public key locally](/terraform/tutorials/cli/verify-archive#downl... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/publish-providers.mdx | main | terraform | [
-0.022690944373607635,
0.055337391793727875,
-0.045513786375522614,
-0.0255491454154253,
-0.015485920011997223,
-0.03339826688170433,
-0.06716971844434738,
-0.08327101916074753,
0.016627322882413864,
0.05221745744347572,
-0.004590052179992199,
-0.05339132621884346,
0.02672983519732952,
-0.... | -0.014175 |
instances of `ORG\_NAME` with the name of your organization. ```shell-session $ curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request POST \ --data @platform.json \ https://app.terraform.io/api/v2/organizations/ORG\_NAME/registry-providers/private/ORG\_NAME/aws/v... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/publish-providers.mdx | main | terraform | [
-0.04590954631567001,
0.014096505008637905,
-0.032182853668928146,
-0.029213305562734604,
0.0018046186305582523,
-0.0487714521586895,
-0.09262599796056747,
-0.011566569097340107,
0.03185390681028366,
0.12450224161148071,
-0.028777282685041428,
-0.04249155893921852,
0.028648963198065758,
-0... | 0.046045 |
[vcs]: /terraform/cloud-docs/vcs # Add public providers and modules to the HCP Terraform private registry You can add providers and modules from the public [Terraform Registry](/terraform/registry) to your HCP Terraform private registry. The private registry stores a pointer to these public providers and modules so tha... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/add.mdx | main | terraform | [
-0.018309690058231354,
0.005596498027443886,
-0.03149046003818512,
-0.0047791143879294395,
0.023150471970438957,
0.04949188977479935,
-0.02667195536196232,
-0.026427891105413437,
-0.01371083501726389,
0.031324781477451324,
0.001563466154038906,
-0.07118190824985504,
-0.009487620554864407,
... | 0.064383 |
or Module Removing a public provider or module from a private registry does not remove it from the public Terraform Registry. Users in the organization can still use the removed provider or module without changing their configurations. To remove a public provider or module from an organization's private registry: 1. Si... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/add.mdx | main | terraform | [
-0.04993986710906029,
0.037276994436979294,
-0.021153569221496582,
0.007252970244735479,
0.034158218652009964,
0.00036487754550762475,
-0.0019636680372059345,
-0.11177784204483032,
0.0030492807272821665,
0.018389498814940453,
0.05850328132510185,
0.007292882073670626,
0.011354375630617142,
... | 0.016625 |
# Publish Stack component configurations to the private registry @include 'beta.mdx' Publish Stack component configurations to your organization's private registry to simplify sharing and versioning configurations with your teams. ## Background Stacks are made up of individual `component` blocks that each source a Terr... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/publish-stack-configuration.mdx | main | terraform | [
-0.009651091881096363,
-0.06241840496659279,
-0.031661197543144226,
-0.014332499355077744,
-0.024194439873099327,
0.011058648116886616,
-0.07452176511287689,
-0.024215862154960632,
0.031789977103471756,
0.01925942488014698,
-0.023245759308338165,
-0.06421846896409988,
0.04038352891802788,
... | 0.015521 |
versions for all component configurations whenever you create a new tag in GitHub. ## Release new versions To release a new version of a component configuration, push a new release tag to the associated VCS repository. The HCP Terraform private registry automatically imports the configuration and creates a new version ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/publish-stack-configuration.mdx | main | terraform | [
0.012696830555796623,
-0.04110031947493553,
0.030887939035892487,
-0.022803105413913727,
0.03061431460082531,
0.01672474667429924,
-0.08608625084161758,
-0.034350331872701645,
-0.003042328404262662,
0.028552789241075516,
0.019086165353655815,
0.0024877649266272783,
-0.009233014658093452,
-... | -0.00206 |
# Use artifacts from the HCP Terraform private registry All users in an organization can view the HCP Terraform private registry and use the available providers, Stack component configurations, and modules. A private registry has some key requirements and differences from the [public Terraform Registry](/terraform/regi... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/using.mdx | main | terraform | [
-0.03697849065065384,
0.0049161044880747795,
-0.04202680289745331,
-0.021923016756772995,
-0.009191161021590233,
-0.0015266123227775097,
-0.025371646508574486,
-0.03217899426817894,
-0.01944376341998577,
0.03666365146636963,
0.028715187683701515,
-0.08519845455884933,
0.03310126066207886,
... | 0.059268 |
{ source = "app.terraform.io/demo-custom-provider/random" version = "1.1.0" } } } ``` The syntax for referencing private modules in the [module block](/terraform/language/modules/syntax) `source` argument is `///`. - \*\*Hostname:\*\* For the SaaS version of HCP Terraform, use `app.terraform.io`. In Terraform Enterpris... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/using.mdx | main | terraform | [
-0.03534133359789848,
0.009802146814763546,
-0.01942349039018154,
0.0018527660286054015,
-0.009339084848761559,
-0.009131005965173244,
-0.009473131969571114,
-0.0373091846704483,
0.04145387187600136,
0.030834080651402473,
-0.011917689815163612,
-0.11971288919448853,
0.056992776691913605,
-... | 0.027855 |
Details: - Supported protocols are HTTP/HTTPS and SSH. - Userinfo is not allowed in the URL (username & password). - Valid Refs (`?ref=`) include: Full commit sha, Git Tag, and Branch name. The following example sources a module named `kube` from a GitHub repository: ```hcl component "my-component" { source = "git::htt... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/using.mdx | main | terraform | [
-0.04501564800739288,
0.036853134632110596,
-0.023717179894447327,
-0.019046833738684654,
-0.014408338814973831,
-0.030144911259412766,
0.005260422360152006,
0.0016744383610785007,
0.05032171308994293,
0.05982140451669693,
-0.013367339968681335,
-0.11380690336227417,
0.05834063142538071,
-... | -0.023177 |
The type of token you choose may grant different permissions. - \*\*User Token\*\*: Allows you to access providers and modules from any organization in which you are a member. You are a member of an organization if you belong to any team in that organization. You can also access modules from any organization that is sh... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/using.mdx | main | terraform | [
-0.08431144058704376,
0.007763002999126911,
-0.05576407164335251,
0.037697676569223404,
0.0073814173229038715,
-0.002170757157728076,
0.04738149791955948,
-0.07123782485723495,
0.07806667685508728,
0.03260918706655502,
-0.015815865248441696,
0.010557233355939388,
0.017380548641085625,
0.08... | 0.13763 |
# Test private modules in the HCP Terraform private registry You can configure HCP Terraform to automatically run tests for modules in your private registry. When enabled, HCP Terraform will run tests for every commit to the designated branch. This lets you verify that it is safe to publish new module versions. ## Enab... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/registry/test.mdx | main | terraform | [
0.010766732506453991,
-0.03723530098795891,
-0.011004078201949596,
0.023597920313477516,
0.0066809807904064655,
0.013015887700021267,
-0.12219604849815369,
-0.09338053315877914,
-0.038595087826251984,
0.06728512793779373,
0.02871575765311718,
-0.02725987695157528,
0.047108668833971024,
0.0... | -0.00106 |
# Encrypt your state and plan files The hold your own key (HYOK) feature lets you authenticate a key management system with HCP Terraform to encrypt HCP Terraform state and plan data with a key that you provide and control. ## Introduction @include 'tfc-package-callouts/hyok.mdx' Terraform artifacts can contain sensiti... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/hold-your-own-key/index.mdx | main | terraform | [
-0.0030395316425710917,
0.10530729591846466,
-0.02641674131155014,
-0.06076623871922493,
-0.03430244326591492,
0.012700608931481838,
0.014911575242877007,
-0.005871259141713381,
-0.015280642546713352,
0.006814951542764902,
-0.04428514093160629,
-0.05656418949365616,
0.07180973887443542,
-0... | 0.044449 |
for your HCP Terraform organization. An HYOK configuration in HCP Terraform configures the following: - How to authenticate to your KMS using OIDC. - Which key HCP Terraform uses for this configuration. - The name to identify of the configuration within HCP Terraform. After configuring a key, HCP Terraform will automat... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/hold-your-own-key/index.mdx | main | terraform | [
0.000376299925846979,
0.06680663675069809,
-0.01227858942002058,
0.003414517967030406,
-0.03402041643857956,
0.00009579845209373161,
-0.00016453170974273235,
-0.06648313254117966,
0.0215016957372427,
0.02222605235874653,
-0.033293962478637695,
-0.03791842982172966,
0.07604961842298508,
-0.... | 0.010356 |
# Hold your own key concepts The hold your own key (HYOK) feature lets you authenticate a key management system with HCP Terraform to encrypt HCP Terraform state and plan data with a key that you provide and control. @include 'tfc-package-callouts/hyok.mdx' Terraform artifacts can contain sensitive information, such as... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/hold-your-own-key/concepts.mdx | main | terraform | [
-0.030555682256817818,
0.09522267431020737,
-0.052130065858364105,
-0.03622562065720558,
-0.005800633225589991,
-0.05508573353290558,
0.025034219026565552,
-0.007348712999373674,
0.01406256016343832,
0.016878897324204445,
0.02452119253575802,
-0.028267795220017433,
0.058669205754995346,
-0... | 0.146161 |
HCP Terraform agent decrypts plan data before running your policies, ensuring your policies continue to run as expected. ## Encryption process HYOK uses a process called [envelope encryption](https://cloud.ibm.com/docs/key-protect?topic=key-protect-envelope-encryption#envelope-encryption-overview) to secure artifacts u... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/hold-your-own-key/concepts.mdx | main | terraform | [
-0.029179884120821953,
0.07259228080511093,
-0.010487344115972519,
-0.012638850137591362,
-0.01614348031580448,
-0.06942969560623169,
0.03193988651037216,
-0.05484049394726753,
0.051687877625226974,
0.04732512682676315,
-0.008618541993200779,
-0.04319734871387482,
0.05239207670092583,
-0.0... | 0.101647 |
the agent proxy detects the upload, which stream-encrypts the artifact with your workspace's DEK on its way to HCP Terraform's storage service. All HCP Terraform artifacts are encrypted using AES256-GCM, with AEAD based on the ID of the artifact to be encrypted: - Key size: 32 bytes - HKDF algo: `HMAC-SHA256` - Size of... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/hold-your-own-key/concepts.mdx | main | terraform | [
-0.015593179501593113,
0.08773704618215561,
0.02819051407277584,
-0.06528790295124054,
-0.008237199857831001,
-0.03864835947751999,
-0.0047441450878977776,
-0.07175861299037933,
0.0253065787255764,
0.04222040995955467,
-0.041456352919340134,
-0.05479547381401062,
0.04891561344265938,
-0.05... | 0.011276 |
necessary requests to your KMS. The HCP Terraform agent uses the KMS's encryption-as-a-service functionality to encrypt and decrypt the necessary data encryption key(s) without accessing the KEK. | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/hold-your-own-key/concepts.mdx | main | terraform | [
-0.020915117114782333,
0.08685299754142761,
0.004712685011327267,
-0.05860888585448265,
-0.004188058897852898,
0.004944830201566219,
0.00610645255073905,
-0.0858590379357338,
0.04333267733454704,
0.025337345898151398,
-0.013391315005719662,
-0.08654507249593735,
0.045653749257326126,
-0.08... | 0.096607 |
# Configure and manage keys Configure your key management system (KMS) and HCP Terraform to use the hold your own key (HYOK) feature to encrypt your sensitive Terraform artifacts. ## Background HCP Terraform lets you configure multiple HYOK configurations for an organization. Each HYOK configuration corresponds to a si... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/hold-your-own-key/configure.mdx | main | terraform | [
0.0034295981749892235,
0.05436639115214348,
-0.039177797734737396,
-0.031138379126787186,
-0.03758782148361206,
-0.04265345260500908,
0.01202654279768467,
-0.02412886917591095,
-0.0028691869229078293,
0.01737978868186474,
0.0010556173510849476,
-0.07309167087078094,
0.06672101467847824,
-0... | 0.055079 |
\*\*Audience\*\*: Leave this as the default value, `api://AzureADTokenExchange`. Make a note of the HYOK config name you choose here, you will use it later when you configure HCP Terraform. To use AWS with HYOK, you need to configure the following: - An OIDC Identity Provider for HCP Terraform. - An IAM role with a tru... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/hold-your-own-key/configure.mdx | main | terraform | [
-0.014526886865496635,
0.07323529571294785,
-0.04169277474284172,
0.022084522992372513,
-0.020065966993570328,
0.011936572380363941,
0.047826699912548065,
-0.03724642097949982,
-0.005953759886324406,
0.04661215841770172,
-0.011223536916077137,
-0.13013942539691925,
0.08534274250268936,
-0.... | 0.06682 |
encrypt and decrypt data using your key. For example, you could use the \*\*Cloud KMS CryptoKey Encrypter/Decrypter\*\* role, though you may want further scope access to only your key. ### Create a Workload Identity Pool and Provider Create a workload identity pool and provider by following the steps in [Configure Work... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/hold-your-own-key/configure.mdx | main | terraform | [
-0.020447785034775734,
0.08604907989501953,
-0.007294611074030399,
-0.02038138546049595,
-0.031948190182447433,
-0.02941046841442585,
0.061834052205085754,
-0.02425399050116539,
0.009343545883893967,
0.04834038391709328,
-0.013723318465054035,
-0.10455506294965744,
0.09160235524177551,
-0.... | 0.037248 |
is `unique-prod`: ```shell-session $ vault write -f transit/keys/unique-prod Key Value --- ----- allow\_plaintext\_backup false auto\_rotate\_period 0s deletion\_allowed false derived false exportable false imported\_key false keys map[1:1738617996] latest\_version 1 min\_available\_version 0 min\_decryption\_version 1... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/hold-your-own-key/configure.mdx | main | terraform | [
-0.015781573951244354,
0.02530091628432274,
-0.05468660965561867,
-0.05651988461613655,
-0.005008976440876722,
0.01998106762766838,
0.0523645393550396,
0.020702602341771126,
0.02154838852584362,
-0.03395470231771469,
-0.0024729345459491014,
-0.031710606068372726,
0.12422765046358109,
-0.06... | -0.081237 |
KMS to check for new key versions. The agent pool you specify is not used to perform Terraform runs. HCP Terraform continues to use the agent pool specified in your workspace's execution mode when performing runs. The agents running your workspace's operations do not require request forwarding, but you should update th... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/hold-your-own-key/configure.mdx | main | terraform | [
0.015002182684838772,
0.013607571832835674,
0.007390614133328199,
-0.005393143743276596,
-0.03882940858602524,
-0.0008438277873210609,
-0.011541982181370258,
-0.09863720834255219,
0.03330878168344498,
0.0720289796590805,
-0.029483972117304802,
-0.08155526965856552,
0.06803677976131439,
-0.... | 0.007345 |
for example `global` or `us-central1`. To configure your key in HCP Terraform, you need the \*\*Name\*\* of the key you created in the transit secrets engine. In the Vault configuration example above, this was `unique-prod`. ### Test the key configuration To test your HYOK configuration, click \*\*Test Connection\*\* o... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/hold-your-own-key/configure.mdx | main | terraform | [
0.009129680693149567,
0.04180740565061569,
-0.03498455137014389,
-0.02953210286796093,
-0.06119440123438835,
0.0005206175264902413,
-0.009099692106246948,
-0.03971288725733757,
-0.043587468564510345,
-0.0025444580242037773,
0.008011030033230782,
-0.08046593517065048,
0.09639906138181686,
-... | 0.018262 |
To revoke a key configuration: 1. Navigate to your organization's \*\*Settings\*\*. 1. Then to \*\*HYOK Encryption\*\*. 1. Click the \*\*Revoke\*\* button next to the HYOK configuration you want to revoke. When you revoke a key configuration, HCP Terraform migrates all of the workspaces that used that configuration to ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/hold-your-own-key/configure.mdx | main | terraform | [
0.007210952695459127,
0.11570805311203003,
0.04663270339369774,
-0.0079942736774683,
-0.02351437322795391,
-0.011167346499860287,
-0.006350861396640539,
-0.07259125262498856,
-0.0167658943682909,
0.005607604049146175,
0.0034025670029222965,
-0.009435002692043781,
0.08249952644109726,
-0.07... | -0.036365 |
[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/agents.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 |
"name": "example-pool", "created-at": "2020-08-05T18:10:26.964Z", "organization-scoped": false, "agent-count": 3 }, "relationships": { "agents": { "links": { "related": "/api/v2/agent-pools/apool-yoGUFz5zcRMMz53i/agents" } }, "authentication-tokens": { "links": { "related": "/api/v2/agent-pools/apool-yoGUFz5zcRMMz53i/a... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/agents.mdx | main | terraform | [
-0.06419328600168228,
0.06384261697530746,
-0.0333663634955883,
0.03366746008396149,
-0.015717634931206703,
-0.01215977780520916,
-0.0240702535957098,
-0.054839204996824265,
0.05394132062792778,
-0.015623650513589382,
0.012870771810412407,
-0.07066341489553452,
0.018880881369113922,
0.1163... | 0.048591 |
"attributes": { "name": "example-pool", "created-at": "2020-08-05T18:10:26.964Z", "organization-scoped": false }, "relationships": { "agents": { "links": { "related": "/api/v2/agent-pools/apool-yoGUFz5zcRMMz53i/agents" } }, "authentication-tokens": { "links": { "related": "/api/v2/agent-pools/apool-yoGUFz5zcRMMz53i/aut... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/agents.mdx | main | terraform | [
-0.0641876831650734,
0.08457119762897491,
-0.025878818705677986,
0.047925688326358795,
0.011598064564168453,
-0.01392652839422226,
-0.023055020719766617,
-0.07081049680709839,
0.05108373612165451,
-0.006730798631906509,
0.013768722303211689,
-0.07355473935604095,
0.02057230845093727,
0.118... | 0.0385 |
The name of the agent pool, which can only include letters, numbers, `-`, and `\_`. This will be used as an identifier and must be unique in the organization. | | `data.attributes.organization-scoped` | bool | true | The scope of the agent pool. If true, all workspaces in the organization can use the agent pool. | | `d... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/agents.mdx | main | terraform | [
-0.02246609330177307,
-0.0341426245868206,
-0.03278510645031929,
0.020357344299554825,
-0.03323924541473389,
-0.015265661291778088,
0.021138738840818405,
-0.1311585158109665,
0.01929585263133049,
0.015195597894489765,
-0.0010240791598334908,
-0.08325579762458801,
0.06124167889356613,
0.058... | 0.022095 |
"allowed-stacks": { "data": [ { "id": "st-udYJjMCsnxU87uur", "type": "stacks" } ] }, "excluded-stacks": "data": [ { "id": "st-ksVruWHkgjHVB8zM", "type": "stacks" } ] }, "allowed-projects": { "data": [ { "id": "prj-WsVcWRr7SfxRci1v", "type": "projects" } ] }, "allowed-modules": { "data": [ { "id": "mod-Xf3VzW5zcRMMz12a"... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/agents.mdx | main | terraform | [
-0.048221029341220856,
0.06678059697151184,
-0.019251596182584763,
0.025383301079273224,
0.04406887665390968,
-0.04840968921780586,
-0.0011046035215258598,
-0.034731291234493256,
-0.012713168747723103,
-0.02990592271089554,
0.08347286283969879,
-0.04652762785553932,
0.011771045625209808,
0... | -0.013127 |
from processing tests for. Only available when the enterprise-testing feature is enabled. | ### Sample Payload ```json { "data": { "type": "agent-pools", "attributes": { "name": "example-pool", "organization-scoped": false }, "relationships": { "allowed-workspaces": { "data": [ { "id": "ws-x9taqV23mxrGcDrn", "type": "w... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/agents.mdx | main | terraform | [
-0.05512871593236923,
0.04076641425490379,
-0.029499780386686325,
0.06322474777698517,
-0.002566293813288212,
-0.07687351107597351,
-0.0564952977001667,
-0.07823484390974045,
0.019315095618367195,
-0.023211341351270676,
0.03248005360364914,
-0.044160354882478714,
0.0006404672167263925,
0.0... | 0.059223 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/no-code-provisioning.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
### Sample Request ```shell curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request POST \ --data @payload.json \ https://app.terraform.io/api/v2/organizations/my-organization/no-code-modules ``` ### Sample Response ```json { "data": { "id": "nocode-9HE91XDNY3faePn... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/no-code-provisioning.mdx | main | terraform | [
-0.040156252682209015,
0.028018290176987648,
-0.013591067865490913,
0.0049933744594454765,
0.0032253190875053406,
-0.052226997911930084,
-0.07630176097154617,
-0.0704609602689743,
0.04743892326951027,
0.09427715837955475,
0.009012586437165737,
-0.09283937513828278,
-0.0007887007668614388,
... | 0.029209 |
"type": "variable-options", "attributes": { "variable-name": "Linux AMIs", "variable-type": "array", "options": [ "Xenial Xerus", "Trusty Tahr" ] } }, { "id": "ncvaropt-dZMfdh9KBcwFjyv2", "type": "variable-options", "attributes": { "variable-name": "region", "variable-type": "array", "options": [ "eu-north-1", "us-east... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/no-code-provisioning.mdx | main | terraform | [
0.031221099197864532,
0.09979099035263062,
-0.03386741131544113,
-0.024952510371804237,
-0.004481672775000334,
-0.027809247374534607,
0.01561108697205782,
-0.002708651125431061,
0.003291209228336811,
0.06389762461185455,
-0.007830356247723103,
-0.13906624913215637,
0.0057445610873401165,
0... | 0.039026 |
} ] } ``` ## Create a no-code module workspace This endpoint creates a workspace from a no-code module. `POST /no-code-modules/:id/workspaces` | Parameter | Description | | -------------------- | ------------------------------------------ | | `:id` | The ID of the no-code module to provision. | Each HCP Terraform organ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/no-code-provisioning.mdx | main | terraform | [
-0.048713572323322296,
-0.021613048389554024,
-0.052898868918418884,
0.011241206899285316,
-0.040495824068784714,
-0.005051031708717346,
-0.04276798665523529,
-0.06684858351945877,
0.0004102753009647131,
0.0421723835170269,
0.007701788563281298,
-0.0917513445019722,
0.04930087924003601,
-0... | 0.054447 |
to a specific project. | | `data.relationships.project.data.type` | string | | Must be `"project"`. | | `data.relationships.vars.data[].type` | string | | Must be `"vars"`. | | `data.relationships.vars.data[].attributes.key` | string | | The name of the variable. | | `data.relationships.vars.data[].attributes.value` | ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/no-code-provisioning.mdx | main | terraform | [
0.01226906105875969,
0.040051575750112534,
-0.025535576045513153,
0.023036707192659378,
-0.0298427976667881,
0.004428006708621979,
0.022771459072828293,
-0.07444579154253006,
0.008645921014249325,
0.022624868899583817,
0.010448403656482697,
-0.14133678376674652,
0.08468394726514816,
0.0077... | -0.071915 |
Use the [confirm and apply a workspace upgrade plan API](#confirm-and-apply-a-workspace-upgrade-plan) to complete the workspace upgrade. `POST /no-code-modules/:no\_code\_module\_id/workspaces/:id/upgrade` | Parameter | Description | | -------------------- | -------------------------------| | `:no\_code\_module\_id` | ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/no-code-provisioning.mdx | main | terraform | [
-0.09345629066228867,
-0.016847660765051842,
-0.026729073375463486,
0.0297586340457201,
-0.018226591870188713,
-0.05470846965909004,
-0.04123184084892273,
-0.031215965747833252,
0.0003922314790543169,
0.007965724915266037,
0.017414463683962822,
-0.05581926926970482,
-0.004723688587546349,
... | -0.024252 |
provisioning settings. `POST /no-code-modules/:no\_code\_module\_id/workspaces/:workspace\_id/upgrade/:id` | Parameter | Description | | -------------------- | -------------------------------| | `:no\_code\_module\_id` | The ID of the no-code module. | | `:workspace\_id` | The ID of workspace. | | `:id` | The ID of upd... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/no-code-provisioning.mdx | main | terraform | [
-0.047363270074129105,
0.01419783290475607,
-0.0449540801346302,
0.010341839864850044,
0.00041750181117095053,
-0.06514513492584229,
-0.07171362638473511,
-0.058070167899131775,
0.028985915705561638,
0.1239788830280304,
0.02898346446454525,
-0.0729038342833519,
0.020331313833594322,
-0.033... | 0.020736 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/variables.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
lists variables for all workspaces where you have permission to read variables. ([More about permissions.](/terraform/cloud-docs/users-teams-organizations/permissions)) [permissions-citation]: #intentionally-unused---keep-for-maintainers ### Sample Request ```shell $ curl \ --header "Authorization: Bearer $TOKEN" \ --h... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/variables.mdx | main | terraform | [
0.017927449196577072,
0.08204977959394455,
0.0023871459998190403,
0.04897720366716385,
0.019716015085577965,
-0.04976760223507881,
0.024242637678980827,
-0.0798524022102356,
0.054437629878520966,
0.05866941437125206,
-0.0025917969178408384,
-0.08326403796672821,
-0.007506649009883404,
0.04... | -0.001515 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/oauth-clients.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
"type": "oauth-clients", "attributes": { "created-at": "2018-04-16T20:42:53.771Z", "callback-url": "https://app.terraform.io/auth/35936d44-842c-4ddd-b4d4-7c741383dc3a/callback", "connect-path": "/auth/35936d44-842c-4ddd-b4d4-7c741383dc3a?organization\_id=1", "service-provider": "github", "service-provider-display-name"... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/oauth-clients.mdx | main | terraform | [
-0.052061837166547775,
0.0087739247828722,
-0.05370697006583214,
0.007356739137321711,
-0.005705640185624361,
-0.06709369271993637,
-0.05515936017036438,
-0.06697338074445724,
0.08214970678091049,
0.10228807479143143,
-0.002299221698194742,
-0.037163738161325455,
0.059144988656044006,
0.02... | 0.001392 |
text of the SSH private key associated with your Bitbucket Data Center application link. | | `data.attributes.rsa-public-key` | string | | \*\*Required for Bitbucket Data Center in conjunction with the `secret`. Not used for any other providers.\*\* The text of the SSH public key associated with your Bitbucket Data Cen... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/oauth-clients.mdx | main | terraform | [
-0.027904268354177475,
0.03090037778019905,
-0.10470100492238998,
0.08336854726076126,
0.026674814522266388,
-0.031643930822610855,
0.005092035047709942,
-0.05068246275186539,
0.07490882277488708,
0.026081349700689316,
-0.015094473026692867,
-0.012180806137621403,
0.06561595946550369,
0.01... | -0.023587 |
or another type of client key for the VCS provider. | | `data.attributes.secret` | string | (previous value) | The OAuth client secret. For Bitbucket Data Center, this secret is the text of the SSH private key associated with your Bitbucket Data Center application link. | | `data.attributes.rsa-public-key` | string | (... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/oauth-clients.mdx | main | terraform | [
-0.06112886220216751,
0.010854077525436878,
-0.04666002094745636,
0.029606452211737633,
-0.0033629636745899916,
0.012686403468251228,
0.013732885010540485,
-0.033207036554813385,
0.08842713385820389,
0.0768396183848381,
0.0059256721287965775,
-0.029384508728981018,
0.08197594434022903,
-0.... | -0.048411 |
--header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request DELETE \ https://app.terraform.io/api/v2/oauth-clients/oc-XKFwG6ggfA9n7t1K ``` ## Attach to a project `POST /oauth-clients/:id/relationships/projects` | Parameter | Description | | --------- | -----------------------... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/oauth-clients.mdx | main | terraform | [
-0.04431520029902458,
0.10592593997716904,
-0.006221357733011246,
0.030251571908593178,
0.03910251706838608,
-0.05817817896604538,
-0.0038308058865368366,
-0.017032451927661896,
0.0937197208404541,
0.04639450088143349,
-0.01895042136311531,
-0.09440816938877106,
0.056037530303001404,
0.039... | 0.014345 |
Description | | -------------- | ---------------------------------------- | | `oauth\_tokens` | The OAuth tokens managed by this client | | `projects` | The projects scoped to this client | | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/oauth-clients.mdx | main | terraform | [
-0.04066934436559677,
0.0663999393582344,
0.003737060585990548,
0.016791652888059616,
0.04838171973824501,
-0.04436014965176582,
0.06129705533385277,
0.01816406473517418,
0.04760954901576042,
-0.07834962755441666,
-0.03908704221248627,
-0.007472370285540819,
0.08354949951171875,
0.00017199... | 0.039277 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/oauth-tokens.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
Properties without a default value are required. | Key path | Type | Default | Description | | ------------------------- | ------ | ------- | ------------------------- | | `data.type` | string | | Must be `"oauth-tokens"`. | | `data.attributes.ssh-key` | string | | \*\*Optional.\*\* The SSH key | ### Sample Payload ```... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/oauth-tokens.mdx | main | terraform | [
0.04572492092847824,
0.07950480282306671,
-0.019756773486733437,
0.026746045798063278,
-0.007528373971581459,
-0.022910933941602707,
-0.018105963245034218,
0.05497279390692711,
0.04771051183342934,
-0.024687429890036583,
-0.0014329623663797975,
-0.1062299832701683,
0.02166132815182209,
0.0... | -0.046501 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/agent-tokens.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
[500][] | [JSON API error object][] | Failure during Agent Token creation | ### Request Body This POST endpoint requires a JSON object with the following properties as a request payload. Properties without a default value are required. | Key path | Type | Default | Description | | ----------------------------- | ------... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/agent-tokens.mdx | main | terraform | [
-0.018497075885534286,
0.0612403005361557,
-0.028910713270306587,
0.007691494654864073,
-0.05176844075322151,
-0.03177759051322937,
-0.028275374323129654,
0.023451728746294975,
0.04495570808649063,
0.0025746070314198732,
-0.021762406453490257,
-0.09314054995775223,
0.01339267659932375,
0.0... | 0.046778 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/account.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
| [JSON API error object][] | Unauthorized | | [422][] | [JSON API error object][] | Malformed request body (missing attributes, wrong types, etc.) | ### Request Body This PATCH endpoint requires a JSON object with the following properties as a request payload. | Key path | Type | Default | Description | | ------------... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/account.mdx | main | terraform | [
-0.06883896887302399,
0.024041442200541496,
-0.035400208085775375,
0.005632881540805101,
-0.07450248301029205,
-0.06865373998880386,
-0.0009012350346893072,
0.018947217613458633,
-0.023500898852944374,
0.029979120939970016,
0.001448499271646142,
-0.06651592254638672,
0.04484717175364494,
0... | -0.000403 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/github-app-installations.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
# VCS events API reference -> \*\*Note\*\*: The VCS Events API is still in beta as support is being added for additional VCS providers. Currently only GitLab.com connections established after December 2020 are supported. VCS (version control system) events describe changes within your organization for VCS-related actio... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/vcs-events.mdx | main | terraform | [
-0.035735953599214554,
0.02360043115913868,
0.01822294294834137,
0.017164485529065132,
0.03342166170477867,
-0.05483488366007805,
-0.008408159017562866,
-0.03966129943728447,
0.14580465853214264,
0.07071278989315033,
-0.05795877054333687,
-0.030502621084451675,
-0.006822471972554922,
-0.02... | 0.037746 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/group-member-roles.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
| ### Query Parameters This endpoint supports pagination [with standard URL query parameters](/terraform/cloud-docs/api-docs#query-parameters). Remember to percent-encode `[` as `%5B` and `]` as `%5D` if your tooling doesn't automatically encode URLs. | Parameter | Description | | --------------- | --------------------... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/group-member-roles.mdx | main | terraform | [
-0.020988523960113525,
0.08490979671478271,
0.04145219177007675,
0.009616111405193806,
-0.08794776350259781,
0.028641995042562485,
-0.07210508733987808,
-0.07182466238737106,
0.05727924406528473,
0.07317671179771423,
-0.05782374367117882,
-0.057522159069776535,
0.05541406571865082,
-0.0654... | -0.032122 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [307]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/comments.mdx | main | terraform | [
-0.026010459288954735,
-0.02275005355477333,
-0.026095468550920486,
-0.018418513238430023,
-0.02009897492825985,
-0.08436909317970276,
-0.05374377593398094,
-0.0791759043931961,
-0.0060250526294112206,
-0.03486490249633789,
0.03005075827240944,
0.05508139356970787,
0.0022271922789514065,
-... | 0.068675 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [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/notification-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 |
the following information: | Name | Type | Description | | -------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations.mdx | main | terraform | [
-0.0062637473456561565,
0.05819385498762131,
-0.010701271705329418,
0.014665198512375355,
-0.06705909967422485,
0.030755065381526947,
0.041231099516153336,
0.0019502727081999183,
0.026196254417300224,
-0.059626683592796326,
0.012803749181330204,
-0.0465838797390461,
-0.010636583901941776,
... | 0.046641 |
null, } ] } ``` ### Workspace notification payload Workspace events include detailed information about workspace-level validation events like [health assessments](/terraform/cloud-docs/workspaces/health) if you enable them for the workspace. Much of the information provides details about the associated [assessment resu... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations.mdx | main | terraform | [
0.0006984693463891745,
0.05252385511994362,
0.022176537662744522,
0.004748588893562555,
0.03398037701845169,
0.005954402964562178,
0.028011852875351906,
-0.04656563326716423,
0.013854630291461945,
-0.0025706083979457617,
-0.015675075352191925,
-0.1488606482744217,
0.05879102274775505,
-0.0... | 0.055351 |
Whether assessment detected drift. | | `details.prior\_assessment\_result.resources\_drifted` | number| The number of resources whose configuration does not match the workspace's state file. | | `details.prior\_assessment\_result.resources\_undrifted` | number| The number of resources whose configuration matches the wo... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations.mdx | main | terraform | [
-0.061207544058561325,
0.04435277730226517,
-0.03039756789803505,
0.051448170095682144,
0.07724419981241226,
-0.06915132701396942,
0.05664127320051193,
-0.0039377361536026,
-0.009923171252012253,
-0.025740759447216988,
-0.00010170448513235897,
-0.08324503153562546,
0.06100751832127571,
0.0... | 0.153679 |
"trigger\_scope": "workspace", "trigger": "workspace:auto\_destroy\_results", "message": "Auto Destroy Results", "details": { "auto\_destroy\_at": null, "run\_created\_at": "2022-06-09T05:22:51Z", "run\_status": "applied", "run\_external\_id": "run-vRVQxpqq64EA9V5a", "run\_create\_error\_message": null, "trigger\_type"... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations.mdx | main | terraform | [
-0.027495503425598145,
0.062012430280447006,
0.026614462956786156,
0.008078513666987419,
0.010748472064733505,
0.0017532992642372847,
0.028104690834879875,
0.0005863865371793509,
0.01679607853293419,
0.04313886538147926,
-0.014838841743767262,
-0.0975823849439621,
0.06554551422595978,
-0.0... | 0.070174 |
a verification request will be sent before saving the configuration. If this request receives no response or the response is not successful (HTTP 2xx), the configuration will not save. | Key path | Type | Default | Description | | ---------------------------------- | -------------- | ------- | -------------------------... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations.mdx | main | terraform | [
-0.03303118795156479,
0.017640288919210434,
-0.03202357515692711,
0.01892397738993168,
0.0029857950285077095,
-0.0777784064412117,
-0.05635714903473854,
-0.0339936837553978,
0.0007106595439836383,
0.04088607802987099,
0.037935882806777954,
-0.05407363548874855,
0.07945531606674194,
-0.0828... | -0.055694 |
Remember to percent-encode `[` as `%5B` and `]` as `%5D` if your tooling doesn't automatically encode URLs. | Parameter | Description | | -------------- | ------------------------------------------------------------------------------------------- | | `page[number]` | \*\*Optional.\*\* If omitted, the endpoint will retu... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations.mdx | main | terraform | [
-0.013103889301419258,
0.058879803866147995,
-0.0566248781979084,
0.03129458427429199,
-0.011764554306864738,
-0.023650633171200752,
0.0093971136957407,
-0.014772097580134869,
0.037198521196842194,
0.0077825584448874,
0.007028544787317514,
-0.11580658704042435,
0.07201717793941498,
-0.0493... | 0.006587 |
------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------- | | [200][] | [JSON API document][] (`type: "notification-configurations"`) | Successfully updated the notification configuration | | [400][] | [JSON API error object][]... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations.mdx | main | terraform | [
-0.058830633759498596,
0.03728507086634636,
-0.0004218016692902893,
-0.04377461224794388,
0.045266587287187576,
-0.07925889641046524,
0.009670671075582504,
-0.03107803873717785,
0.03823017701506615,
-0.01843605563044548,
0.04009396955370903,
-0.08132599294185638,
0.05388932302594185,
0.052... | 0.099226 |
"id": "nc-AeUQ2zfKZzW9TiGZ", "type": "notification-configurations", "attributes": { "enabled": true, "name": "Webhook server test", "url": "https://httpstat.us/200", "destination-type": "generic", "token": null, "triggers": [ "run:applying", "run:completed", "run:created", "run:errored", "run:needs\_attention", "run:pl... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations.mdx | main | terraform | [
-0.05192040652036667,
0.0892966017127037,
-0.07126474380493164,
0.035848621279001236,
0.03440173715353012,
-0.09860825538635254,
0.0006311012548394501,
-0.01481440756469965,
0.02686522714793682,
0.03312824293971062,
-0.0235418900847435,
-0.0991319939494133,
0.006411025766283274,
-0.0506037... | 0.112106 |
| string or null | `null` | Optional write-only secure token, which can be used at the receiving server to verify request authenticity. See [Notification Authenticity][notification-authenticity] for more details. | | `data.attributes.triggers` | array | `[]` | Array of triggers for which this configuration will send no... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations.mdx | main | terraform | [
-0.013021634891629219,
0.001052808715030551,
-0.0495227575302124,
0.058396030217409134,
0.07157493382692337,
-0.05089925229549408,
0.09913212060928345,
-0.0592641644179821,
0.0318167507648468,
0.030564719811081886,
0.00418572872877121,
-0.08104220777750015,
0.1063215583562851,
0.0972160100... | 0.091099 |
"attributes": { "enabled": true, "name": "Webhook server test", "url": "https://httpstat.us/200", "destination-type": "generic", "token": null, "triggers": [ "change\_request:created" ], "delivery-responses": [ { "url": "https://httpstat.us/200", "body": "\"200 OK\"", "code": "200", "headers": { "cache-control": [ "pri... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations.mdx | main | terraform | [
-0.0619942732155323,
0.08760575205087662,
-0.09839191287755966,
0.05316804721951485,
0.010899129323661327,
-0.0873313844203949,
0.004688787739723921,
-0.014118198305368423,
0.02986956760287285,
0.060208093374967575,
0.010066932067275047,
-0.09957392513751984,
0.03986882045865059,
-0.031369... | 0.074886 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [307]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/plans.mdx | main | terraform | [
-0.026010459288954735,
-0.02275005355477333,
-0.026095468550920486,
-0.018418513238430023,
-0.02009897492825985,
-0.08436909317970276,
-0.05374377593398094,
-0.0791759043931961,
-0.0060250526294112206,
-0.03486490249633789,
0.03005075827240944,
0.05508139356970787,
0.0022271922789514065,
-... | 0.068675 |
should not be relied upon beyond the initial request. If you need repeat access, you should use this endpoint to generate a new URL each time. -> \*\*Note:\*\* This endpoint is available for plans using Terraform 0.12 and later. For Terraform Enterprise, this endpoint is available from v202005-1, and its stability was ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/plans.mdx | main | terraform | [
-0.04246988892555237,
0.009303000755608082,
0.029232293367385864,
0.020786505192518234,
-0.03713805973529816,
-0.050370749086141586,
-0.05467784032225609,
-0.0335351787507534,
0.06749116629362106,
0.09548787772655487,
-0.06646288931369781,
-0.029693158343434334,
0.024199465289711952,
0.033... | 0.043697 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/index.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
Feature entitlements HCP Terraform is available at multiple pricing tiers, including free, which offer different feature sets. Each organization has a set of \_entitlements\_ that corresponds to its pricing tier. These entitlements determine which HCP Terraform features the organization can use. If an organization does... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/index.mdx | main | terraform | [
-0.009021323174238205,
0.0458824448287487,
0.02180521748960018,
-0.05634573847055435,
0.045754268765449524,
0.03423651307821274,
-0.035676345229148865,
-0.020971808582544327,
-0.019068490713834763,
0.023734580725431442,
-0.03174301236867905,
-0.1482287347316742,
0.05363176017999649,
0.0152... | 0.088571 |
to workspaces. Affects the [OAuth Clients][o-clients], and [OAuth Tokens][o-tokens] endpoints, and determines whether the `data.attributes.vcs-repo` property can be set for [workspaces][]. [agents]: /terraform/cloud-docs/api-docs/agents [agent pools]: /terraform/cloud-docs/api-docs/agents [agent tokens]: /terraform/clo... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/index.mdx | main | terraform | [
-0.04983610287308693,
0.034761421382427216,
0.02051382325589657,
0.05623829364776611,
0.04191097989678383,
-0.05666959285736084,
0.002905472181737423,
-0.04400504752993584,
0.1103229820728302,
0.04383530467748642,
-0.027585096657276154,
-0.04291921108961105,
0.043903667479753494,
0.0022507... | 0.042737 |
is written once and not visible thereafter. | | `data.relationships.workspace.data.type` | string | | Must be `"workspaces"`. | | `data.relationships.workspace.data.id` | string | | The ID of the workspace that owns the variable. | We also always include a sample payload object, to show the document structure more visu... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/index.mdx | main | terraform | [
-0.06405866891145706,
0.017447032034397125,
-0.0451529286801815,
0.08437325805425644,
-0.09826550632715225,
-0.013543103821575642,
-0.05299736559391022,
0.014904893934726715,
0.08932658284902573,
-0.07857391238212585,
-0.016073796898126602,
0.009242205880582333,
0.0790359377861023,
-0.0012... | 0.062336 |
you can see that limit in the `x-ratelimit-limit` header. The following endpoints have lower rate limits: | Method and endpoint | Purpose | Limit | | --- | --- | --- | | `POST /session/two-factor-send-sms` `POST /api/v2/account/actions/two-factor-enable` `POST /api/v2/account/actions/two-factor-resend-verification-code... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/index.mdx | main | terraform | [
0.0014454922638833523,
-0.046429719775915146,
-0.0236235149204731,
0.017305297777056694,
0.011726760305464268,
-0.05325064808130264,
-0.06571561098098755,
0.04771851748228073,
-0.005856489762663841,
0.02743859961628914,
0.10864268243312836,
-0.056143440306186676,
0.05603249743580818,
0.006... | 0.031294 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/policy-checks.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
Use the data in this hash at your own risk. `POST /policy-checks/:id/actions/override` | Parameter | Description | | --------- | --------------------------------------- | | `id` | The ID of the policy check to override. | ### Sample Request ```shell curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Typ... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/policy-checks.mdx | main | terraform | [
-0.04424009099602699,
0.12109950929880142,
0.026579923927783966,
-0.030913887545466423,
0.028433972969651222,
-0.05498791113495827,
-0.00005014597627450712,
-0.028454914689064026,
0.03360581025481224,
0.12948785722255707,
-0.014955765567719936,
-0.06506728380918503,
0.018449360504746437,
-... | -0.005124 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/projects.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
| string | none | Specifies the tag value for each object in the list. | | `data.attributes.default-execution-mode` | boolean | `remote` | Specifies which [execution mode](/terraform/cloud-docs/workspaces/settings#execution-mode) to use by default. Valid values are `remote`, `local`, and `agent`. | | `data.attributes.d... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/projects.mdx | main | terraform | [
-0.003000193042680621,
0.04174269363284111,
0.014453587122261524,
0.046984944492578506,
-0.018880531191825867,
-0.0272704865783453,
0.0006353547796607018,
-0.09231927245855331,
0.0056314910762012005,
0.0683901384472847,
0.00708115566521883,
-0.0497932992875576,
0.03888970986008644,
-0.0092... | -0.026179 |
to bind to the project. Workspaces inherit the tags bound to their project. | | `data.relationships.tag-bindings.data.type` | string | none | Must be `tag-bindings` for each object in the list. | | `data.relationships.tag-bindings.data.attributes.key` | string | none | Specifies the tag key for each object in the list.... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/projects.mdx | main | terraform | [
-0.022887330502271652,
0.004654678516089916,
-0.014021317474544048,
0.03271086513996124,
-0.042825374752283096,
-0.023811228573322296,
0.006191652733832598,
-0.07295557856559753,
0.029837755486369133,
0.06758289039134979,
-0.013583123683929443,
-0.07260561734437943,
0.07600339502096176,
0.... | -0.040726 |
| `filter[permissions][update]` | \*\*Optional.\*\* If present, returns a list of projects that the authenticated user can update. | | `filter[tagged][i][key]` | \*\*Optional.\*\* If specified, restricts results to projects that are tagged with the provided key. Use a value of `"0"` for `i` if you are only using a sing... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/projects.mdx | main | terraform | [
0.01084899716079235,
0.08903592824935913,
0.02000068873167038,
-0.0425596758723259,
0.029749367386102676,
-0.019260887056589127,
0.06445053964853287,
-0.11103588342666626,
-0.04345186799764633,
0.046319782733917236,
-0.020253736525774002,
-0.12784120440483093,
0.0930647924542427,
-0.004053... | -0.02412 |
of the project to delete | | Status | Response | Reason(s) | |---------|---------------------------|-------------------------------------------------------------------| | [204][] | No Content | Successfully deleted the project | | [403][] | [JSON API error object][] | Not authorized to perform a force delete on the pro... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/projects.mdx | main | terraform | [
-0.0567186065018177,
0.06009320914745331,
-0.0619012713432312,
-0.03893490508198738,
0.04718087986111641,
-0.05379859358072281,
-0.006109327077865601,
-0.03831290826201439,
0.08714281767606735,
0.05418255552649498,
0.0479787178337574,
-0.06238185614347458,
0.020783111453056335,
0.045233957... | 0.098373 |
"tb-97ce954636f93a6c", "type": "tag-bindings", "attributes": { "key": "bar", "value": "baz" } } ] } ``` ## Move workspaces into a project This endpoint allows you to move one or more workspaces into a project. You must have permission to move workspaces on the destination project as well as any source project(s). If yo... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/projects.mdx | main | terraform | [
-0.05857633054256439,
-0.05477200821042061,
-0.0639432817697525,
0.039080578833818436,
-0.016682498157024384,
0.0028880101162940264,
-0.007256736513227224,
-0.016403719782829285,
0.03241217881441116,
0.030137207359075546,
-0.019398914650082588,
-0.05391484126448631,
0.0360758975148201,
0.0... | -0.019053 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [202]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/policies.mdx | main | terraform | [
-0.015784088522195816,
-0.01700746826827526,
-0.018668580800294876,
-0.028096551075577736,
-0.024631375446915627,
-0.08318780362606049,
-0.0621652752161026,
-0.07521579414606094,
-0.005580500699579716,
-0.03855427727103233,
0.03281282261013985,
0.0540321059525013,
0.006812138482928276,
-0.... | 0.052879 |
array should consist of a single element. For Sentinel, if the path in the enforcement map does not match the Sentinel policy (`.sentinel`), then HCP Terraform uses the default `hard-mandatory` enforcement level. For OPA, the default enforcement level is `advisory`. | | `data.attributes.enforce[].path` | string | | \*\... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/policies.mdx | main | terraform | [
0.028143364936113358,
0.06619729846715927,
0.03949856013059616,
-0.01548552792519331,
0.009159074164927006,
-0.0318707637488842,
0.03258470445871353,
-0.04859704151749611,
-0.061751145869493484,
0.05501649156212807,
0.0046353149227797985,
-0.06665683537721634,
0.056499335914850235,
-0.0017... | 0.01462 |
"mode": "soft-mandatory" } ], "policy-set-count": 1, "updated-at": "2018-09-11T18:21:21.784Z" }, "relationships": { "organization": { "data": { "id": "my-organization", "type": "organizations" } }, "policy-sets": { "data": [ { "id": "polset-3yVQZvHzf5j3WRJ1", "type": "policy-sets" } ] } }, "links": { "self": "/api/v2/p... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/policies.mdx | main | terraform | [
-0.05553293600678444,
0.09331317991018295,
-0.010371178388595581,
0.025567518547177315,
0.02866450324654579,
-0.008809183724224567,
-0.007761472836136818,
-0.020820166915655136,
0.009836798533797264,
0.0306710097938776,
0.02025325782597065,
-0.029282933101058006,
0.022289516404271126,
0.05... | 0.045157 |
does not match the Sentinel policy (`.sentinel`), then HCP Terraform uses the default `hard-mandatory` enforcement level. For OPA, the default enforcement level is `advisory`. | | `data.attributes.enforce[].path` | string | | \*\*DEPRECATED\*\* For Sentinel, must be `.sentinel`, where `` has the same value as `data.att... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/policies.mdx | main | terraform | [
-0.01567044109106064,
0.05052826553583145,
0.07525745779275894,
-0.014433881267905235,
0.021306486800312996,
-0.052676789462566376,
0.004352835472673178,
-0.030197549611330032,
-0.02896924503147602,
0.0688558891415596,
0.005736514925956726,
-0.07267460972070694,
0.0337551087141037,
0.03003... | -0.002573 |
perform action | ### Sample Request ```shell curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request DELETE \ https://app.terraform.io/api/v2/policies/pl-u3S5p2Uwk21keu1s ``` ## Available Related Resources The GET endpoints above can optionally return related resou... | https://github.com/hashicorp/web-unified-docs/blob/main//content/terraform-docs-common/docs/cloud-docs/api-docs/policies.mdx | main | terraform | [
-0.04062870517373085,
0.06877191364765167,
0.03226441144943237,
0.016349824145436287,
0.030299371108412743,
-0.013410689309239388,
0.007842378690838814,
-0.08177125453948975,
0.032951414585113525,
0.054525263607501984,
-0.03658659756183624,
-0.08055666089057922,
0.06994315981864929,
-0.004... | 0.010525 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.