content large_stringlengths 3 20.5k | url large_stringlengths 53 192 ⌀ | branch large_stringclasses 4
values | source large_stringclasses 51
values | embeddings listlengths 384 384 | score float64 -0.21 0.65 |
|---|---|---|---|---|---|
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 |
appended to the root directory of the repository. | `data.attributes.vcs-repo` | object | | Settings for the Stack's VCS repository. | | `data.attributes.vcs-repo.branch` | string | (nothing) | The repository branch used by this Stack's configuration. If omitted or submitted as an empty string, this defaults to the rep... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/index.mdx | main | terraform | [
-0.021831847727298737,
0.010594138875603676,
0.03656069561839104,
0.013467511162161827,
0.007337379269301891,
-0.030502524226903915,
0.0055698188953101635,
-0.026925453916192055,
0.06998787075281143,
0.0667467936873436,
0.015614490956068039,
-0.08706780523061752,
0.04280484467744827,
-0.04... | 0.022868 |
| |----------------------|--------------------------------------------------| | `:organization\_name` | List all Stacks under the specified organization | ### Query Parameters This endpoint supports pagination [with standard URL query parameters](/terraform/cloud-docs/api-docs#query-parameters); remember to percent-enc... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/index.mdx | main | terraform | [
-0.017373979091644287,
0.017964357510209084,
0.04040917754173279,
0.0025164189282804728,
-0.09030330926179886,
0.010014754720032215,
-0.09081976115703583,
-0.08705861121416092,
0.029809772968292236,
0.07261620461940765,
-0.030878109857439995,
-0.07781865447759628,
0.06313885748386383,
-0.0... | -0.030974 |
"beta": false } } } ``` ## List Stack configuration summaries This endpoint lists configuration summaries for the specified Stack. `GET /stacks/:stack\_id/stack-configuration-summaries` | Parameter | Description | |-------------|---------------------------------------------------| | `:stack\_id` | The Stack id to list ... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/index.mdx | main | terraform | [
-0.025828754529356956,
0.01864088885486126,
0.05816860496997833,
0.010595233179628849,
-0.06056681275367737,
0.019496368244290352,
-0.0656174048781395,
-0.05448552593588829,
0.04942922666668892,
0.09606782346963882,
-0.040750276297330856,
-0.06726470589637756,
0.045568402856588364,
-0.0293... | 0.015165 |
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 |
[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.007408448029309511,
0.09591358155012131,
-0.02168409340083599,
-0.028444936498999596,
-0.009859985671937466,
-0.013870876282453537,
-0.009014722891151905,
0.01282541174441576,
0.03406905755400658,
0.08241260796785355,
-0.0014610867947340012,
-0.0855642780661583,
0.012713435105979443,
-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 |
| `data.attributes.destroy-all` | boolean | `false` | If true, the created configuration will behave as though every deployment in the configuration was declared with `destroy = true`. This enables tearing down the entire Stack's infrastructure without pushing a new configuration. | 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.09307198971509933,
0.04218810424208641,
0.04637223109602928,
0.02040901780128479,
0.01585375890135765,
-0.15105485916137695,
-0.04014536738395691,
-0.037342388182878494,
0.02360406145453453,
0.0032683832105249166,
0.08100820332765579,
0.019409164786338806,
0.05039462074637413,
-0.006067... | 0.023119 |
"json-schemas": "/api/v2/stack-configurations/stc-4EWffseuNa1FpfDH/json-schemas" }, "meta": { "beta": false } } ], "links": { "self": "https://app.terraform.io/api/v2/stacks/st-YwBzgFeeW6Mq4wkH/stack-configurations?page%5Bnumber%5D=1&page%5Bsize%5D=1", "first": "https://app.terraform.io/api/v2/stacks/st-YwBzgFeeW6Mq4wk... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/configurations.mdx | main | terraform | [
-0.060545388609170914,
0.008421125821769238,
0.021523984149098396,
0.01882590726017952,
0.009298279881477356,
-0.028423255309462547,
-0.10626216977834702,
-0.04411441087722778,
0.008479063399136066,
0.0722905620932579,
0.032923635095357895,
-0.050848279148340225,
-0.01439383439719677,
0.02... | 0.042167 |
"Content-Type: application/vnd.api+json" \ https://app.terraform.io/api/v2/stack-configurations/stc-vHvM8dY1cYCVsfuT/stack-diagnostics ``` ### Sample Response ```json { "data": [ { "id": "std-fU7vZ3RS1TRYnrUs", "type": "stack-diagnostics", "attributes": { "severity": "error", "summary": "Diagnostics reported", "detail"... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/stacks/configurations.mdx | main | terraform | [
-0.014215044677257538,
0.047226257622241974,
0.038582026958465576,
-0.015347713604569435,
-0.01373180653899908,
-0.037799786776304245,
-0.09684091806411743,
-0.01791740581393242,
-0.012558882124722004,
0.03979600593447685,
0.00014528782048728317,
-0.12580491602420807,
0.015184237621724606,
... | -0.031936 |
[JSON API document]: /terraform/cloud-docs/api-docs#json-api-documents [JSON API error object]: https://jsonapi.org/format/#error-objects # Notification configurations API reference Use the notifications API endpoints for workspaces, projects, and teams to send notifications to external applications when a triggering e... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations/index.mdx | main | terraform | [
-0.011715443804860115,
-0.013339043594896793,
0.07208342850208282,
0.015217766165733337,
0.04728326573967934,
-0.05103333294391632,
0.007985878735780716,
-0.07100395113229752,
0.04388626664876938,
0.04830712080001831,
-0.058621231466531754,
-0.09623590856790543,
0.05734938755631447,
0.0564... | 0.082311 |
several fields that provide information about the notification attempt: | Name | Type | Description | | --- | --- | --- | | `body` | string | Response body (may be truncated). | | `code` | string | HTTP status code, e.g., `400`. | | `headers` | object | All HTTP headers received, represented as an object with keys for ... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations/index.mdx | main | terraform | [
-0.005896321032196283,
0.04701585695147514,
0.05030636116862297,
0.010690120980143547,
0.037554703652858734,
-0.06312493979930878,
0.025856830179691315,
-0.0791347548365593,
0.012676301412284374,
0.05503981560468674,
-0.054362788796424866,
-0.1521012783050537,
0.08349251747131348,
0.023266... | 0.047984 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400 [404]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations/team.mdx | main | terraform | [
-0.035734470933675766,
0.018102994188666344,
0.02690490148961544,
-0.00449557788670063,
0.02235523797571659,
-0.08126668632030487,
-0.06526800245046616,
-0.09415614604949951,
0.07105513662099838,
0.0559048168361187,
-0.01640825718641281,
-0.006948726251721382,
0.039460960775613785,
0.03493... | 0.037018 |
of the HTTP request by computing the HMAC of the request body using the same shared secret, and dropping any requests with invalid signatures. Sample Ruby code for verifying the HMAC: ```ruby token = SecureRandom.hex hmac = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("sha512"), token, @request.body) fail "Invalid HMAC"... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations/team.mdx | main | terraform | [
-0.050339896231889725,
0.07178304344415665,
0.02482794038951397,
-0.017268041148781776,
0.023848097771406174,
-0.1022597923874855,
0.013271543197333813,
-0.07715033739805222,
0.019929101690649986,
0.009353455156087875,
-0.0014753321884199977,
-0.040473245084285736,
0.07140973210334778,
0.0... | -0.03482 |
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 notifications. See [Notification Triggers][notification-triggers] for more details and a list of allowed v... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations/team.mdx | main | terraform | [
-0.028652988374233246,
0.004301086999475956,
-0.0033529498614370823,
0.038517795503139496,
0.09390150755643845,
-0.08456186205148697,
0.09683535993099213,
-0.062448445707559586,
0.039545394480228424,
0.010943944565951824,
-0.019213203340768814,
-0.06748858094215393,
0.08503049612045288,
0.... | 0.094306 |
["5.1"], "access-control-allow-origin": ["\*"], "x-aspnet-version": ["4.0.30319"], "x-powered-by": ["ASP.NET"], "set-cookie": ["ARRAffinity=77c477e3e649643e5771873e1a13179fb00983bc73c71e196bf25967fd453df9;Path=/;HttpOnly;Domain=httpstat.us"], "date": ["Tue, 08 Jan 2019 21:34:37 GMT"] }, "sent-at": "2019-01-08 21:34:37 ... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations/team.mdx | main | terraform | [
-0.08347306400537491,
0.009508458897471428,
-0.08521414548158646,
0.03775401413440704,
-0.03139889985322952,
-0.09897731244564056,
0.00964970700442791,
-0.10634411871433258,
0.026298580691218376,
0.014892084524035454,
-0.014717541635036469,
-0.03321678563952446,
-0.009108872152864933,
0.04... | 0.049521 |
[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/workspace.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 |
payload conforms to the respective webhook API and results in a notification message with informational attachments. Refer to [Slack Notification Payloads](/terraform/cloud-docs/workspaces/settings/notifications#slack) and [Microsoft Teams Notification Payloads](/terraform/cloud-docs/workspaces/settings/notifications#m... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations/workspace.mdx | main | terraform | [
0.0013440957991406322,
0.028784766793251038,
0.03045271895825863,
0.03180433809757233,
0.0531279519200325,
-0.0636831670999527,
0.002640881109982729,
-0.06287075579166412,
0.0894748643040657,
0.04241928458213806,
-0.036042749881744385,
-0.09334476292133331,
0.019194195047020912,
0.04859527... | 0.099503 |
trigger that caused the notification to be sent. | | `message` | string | Human-readable reason for the notification. | | `details` | object | Object containing details specific to the notification. | | `details.new\_assessment\_result` | object | The most recent assessment result. This result triggered the notificatio... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations/workspace.mdx | main | terraform | [
-0.00033411759068258107,
0.08653762936592102,
0.026167262345552444,
0.02545849047601223,
0.03842166066169739,
-0.030331376940011978,
0.03792615234851837,
-0.040486957877874374,
-0.032875899225473404,
0.05115693435072899,
-0.017705272883176804,
-0.18941521644592285,
0.12187324464321136,
-0.... | 0.110748 |
"ws-XdeUVMWShTesDMME", "workspace\_name": "my-workspace", "organization\_name": "acme-org" } } ``` #### Automatic destroy runs @include 'tfc-package-callouts/ephemeral-workspaces.mdx' Automatic destroy run notifications for workspace events contain 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/workspace.mdx | main | terraform | [
0.0074554430320858955,
0.017181823030114174,
0.021252872422337532,
0.005792395211756229,
0.060432128608226776,
-0.010719693265855312,
0.10307040065526962,
0.010907630436122417,
0.08823441714048386,
-0.02133231982588768,
-0.021286841481924057,
-0.054067157208919525,
0.02421877533197403,
-0.... | 0.093489 |
fail "Invalid HMAC" if hmac != @request.headers["X-TFE-Notification-Signature"] ``` ## Notification verification and delivery responses When saving a configuration with `enabled` set to `true`, or when using the [verify API][], HCP Terraform sends a verification request to the configured URL. The response to this reque... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations/workspace.mdx | main | terraform | [
-0.04174773395061493,
0.0461539551615715,
0.06759926676750183,
-0.03416936472058296,
0.01491521019488573,
-0.0995316281914711,
0.02338380552828312,
-0.1031680777668953,
0.01097883377224207,
0.02855084277689457,
-0.003651683684438467,
-0.10323615372180939,
0.10065029561519623,
0.04785417020... | -0.057179 |
| HTTP or HTTPS URL to which notification requests will be made, only for configurations with `"destination\_type:"` `"slack"`, `"microsoft-teams"` or `"generic"` | | `data.relationships.users` | array | | Array of users part of the organization, only for configurations with `"destination\_type:"` `"email"` | [notifica... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations/workspace.mdx | main | terraform | [
-0.012189310975372791,
0.04229838028550148,
-0.02470962330698967,
0.02133185975253582,
0.05884631723165512,
-0.09433754533529282,
0.04935576394200325,
-0.04313765466213226,
0.05070247873663902,
0.006043776869773865,
-0.028739752247929573,
-0.10638067126274109,
0.069518081843853,
0.08797552... | 0.09456 |
"cache-control": [ "private" ], "content-length": [ "129" ], "content-type": [ "application/json; charset=utf-8" ], "content-encoding": [ "gzip" ], "vary": [ "Accept-Encoding" ], "server": [ "Microsoft-IIS/10.0" ], "x-aspnetmvc-version": [ "5.1" ], "access-control-allow-origin": [ "\*" ], "x-aspnet-version": [ "4.0.303... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations/workspace.mdx | main | terraform | [
-0.033017296344041824,
0.00044987420551478863,
-0.12429454922676086,
0.03683203086256981,
-0.02954036556184292,
-0.046273648738861084,
0.06392350047826767,
-0.07680844515562057,
-0.011547600850462914,
0.06031474098563194,
-0.006894341204315424,
0.022187424823641777,
-0.018811186775565147,
... | -0.004685 |
| string | (previous value) | User-readable name for the configuration. | | `data.attributes.token` | string | (previous value) | 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. | | `... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations/workspace.mdx | main | terraform | [
-0.027856364846229553,
0.022175243124365807,
-0.024363655596971512,
0.06766115874052048,
0.04502088204026222,
-0.040834199637174606,
0.10088207572698593,
-0.04230646416544914,
0.05965813249349594,
0.012896574102342129,
-0.018432175740599632,
-0.043135978281497955,
0.08362972736358643,
0.07... | 0.108603 |
| | [204][] | None | Successfully deleted the notification configuration | | [404][] | [JSON API error object][] | Notification configuration not found, or user unauthorized to perform action | ### Sample request ```shell $ curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+jso... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations/workspace.mdx | main | terraform | [
-0.012020154856145382,
0.035624586045742035,
-0.0009070464875549078,
-0.015259066596627235,
0.04662810266017914,
-0.05336223915219307,
0.008049251511693,
-0.0831112489104271,
0.08018693327903748,
0.07890114933252335,
0.006743024569004774,
-0.05532259866595268,
0.0543997548520565,
0.0552705... | 0.097784 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [201]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201 [204]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204 [400]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400 [404]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations/project.mdx | main | terraform | [
-0.03730262070894241,
0.014760579913854599,
0.028322530910372734,
-0.0017494475468993187,
0.019300375133752823,
-0.0751567929983139,
-0.056192707270383835,
-0.0901452973484993,
0.07135434448719025,
0.06353126466274261,
-0.01867540180683136,
-0.018459146842360497,
0.043195296078920364,
0.04... | 0.04173 |
| `run\_url` | string | URL used to access the run UI page. | | `run\_id` | string | ID of the run which triggered this notification. | | `run\_message` | string | The reason the run was queued. | | `run\_created\_at` | string | Timestamp of the run's creation. | | `run\_created\_by` | string | Username of the user who... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations/project.mdx | main | terraform | [
-0.06384000182151794,
-0.024203678593039513,
-0.09115687012672424,
0.07033054530620575,
0.01491065975278616,
-0.02366875298321247,
0.11296870559453964,
-0.0021086784545332193,
0.03492533043026924,
-0.02114558033645153,
-0.025873756036162376,
-0.0470295287668705,
0.04142666608095169,
-0.046... | 0.207273 |
Create a project notification configuration If a notification configuration has no users assigned, HCP Terraform sends email notifications to all project members. Use this endpoint to create a notification configuration to notify users. `POST /projects/:project\_id/notification-configurations` | Parameter | Description... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations/project.mdx | main | terraform | [
-0.05434732884168625,
0.026495061814785004,
0.02093317359685898,
0.0003312127373646945,
-0.005722886882722378,
-0.06646523624658585,
0.04342488572001457,
-0.035548314452171326,
0.027096888050436974,
0.04868609830737114,
-0.03856649249792099,
-0.1331496238708496,
0.09123558551073074,
0.0874... | 0.074478 |
"run:applying", "run:completed", "run:created", "run:errored", "run:needs\_attention", "run:planning" ], "delivery-responses": [ { "url": "https://httpstat.us/200", "body": "\"200 OK\"", "code": "200", "headers": { "cache-control": ["private"], "content-length": ["129"], "content-type": ["application/json; charset=utf-... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations/project.mdx | main | terraform | [
-0.04455006867647171,
0.02254362590610981,
-0.09285065531730652,
0.09279245138168335,
-0.0005814136238768697,
-0.05506785213947296,
0.020812436938285828,
-0.012778502888977528,
-0.01668052189052105,
0.04153941571712494,
-0.011220145970582962,
-0.018876884132623672,
0.03298011049628258,
0.0... | 0.039998 |
| Optional write-only secure token. | | `data.attributes.triggers` | array | (previous value) | Array of triggers for sending notifications. | | `data.attributes.url` | string | (previous value) | HTTP or HTTPS URL to which notification requests will be made for `generic`, `slack`, or `microsoft-teams` destinations. | ... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations/project.mdx | main | terraform | [
-0.008050506003201008,
0.025495897978544235,
0.03202763944864273,
0.03951682895421982,
0.022950366139411926,
-0.04533667489886284,
0.038369592279195786,
-0.056846603751182556,
0.06860291957855225,
0.10705334693193436,
-0.050321146845817566,
-0.11858770996332169,
0.0603419654071331,
0.06021... | 0.084107 |
[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 |
VCS provider. | ## Create a Test `POST /organizations/:organization\_name/tests/registry-modules/private/:namespace/:name/:provider/test-runs` | Parameter | Description | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------... | 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.035842567682266235,
-0.003363795345649123,
-0.10670890659093857,
0.047052353620529175,
-0.07758723199367523,
-0.001368054305203259,
-0.007511789444833994,
0.04630475491285324,
-0.007967296987771988,
-0.0013303301529958844,
0.07880588620901108,
-0.0902816578745842,
-0.027684245258569717,
... | 0.075527 |
| Parameter | Description | | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `:organization\_name` | The name of the organization for the m... | 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.046616919338703156,
0.06805253028869629,
-0.09828352928161621,
0.010365401394665241,
-0.10925274342298508,
0.01197000127285719,
0.023786792531609535,
-0.024009976536035538,
-0.025926955044269562,
-0.03195039555430412,
0.06630886346101761,
-0.08153337985277176,
0.005249291658401489,
-0.0... | 0.16131 |
Enterprise API" }, "relationships": { "configuration-version": { "data": { "id": "cv-d3zBGFf5DfWY4GY9", "type": "configuration-versions" }, "links": { "related": "/api/v2/configuration-versions/cv-d3zBGFf5DfWY4GY9" } }, "created-by": { "data": { "id": "user-zsRFs3AGaAHzbEfs", "type": "users" }, "links": { "related": "/... | 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.048132579773664474,
0.08101542294025421,
-0.06838087737560272,
0.048638638108968735,
-0.0014403363456949592,
-0.011499849148094654,
-0.032609324902296066,
0.014497964642941952,
-0.024443771690130234,
-0.01869390346109867,
0.04203081130981445,
-0.09577757865190506,
0.01548327598720789,
0... | 0.014294 |
organization for the module. The organization must already exist, and the token authenticating the API request must belong to the `owners` team or a member of the `owners` team. | | `:namespace` | The namespace of the module for which the test is being force-canceled. For private modules this is the same as the `:organ... | 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.05699482187628746,
0.010243900120258331,
0.020932955667376518,
0.045334428548812866,
-0.00012416679237503558,
-0.06538703292608261,
-0.008603105321526527,
-0.06976386904716492,
0.06166376173496246,
0.08197645097970963,
0.015474152751266956,
-0.04026438668370247,
0.06597545742988586,
0.0... | 0.088044 |
"vars", "attributes": { "key": "keykey", "value": "some\_value", "sensitive": false, "category": "env", "hcl": false, "created-at": "2023-10-03T19:47:05.393Z", "description": "some description", "version-id": "699b14ea5d5e5c02f6352fac6bfd0a1424c21d32be14d1d9eb79f5e1f28f663a" }, "links": { "self": "/api/v2/vars/var-xSCU... | 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.01904536969959736,
0.06627221405506134,
-0.0666903704404831,
0.0712098628282547,
-0.02214301936328411,
0.009473225101828575,
0.05096685141324997,
0.017398303374648094,
-0.022714022547006607,
-0.023059865459799767,
0.07436095178127289,
-0.09169012308120728,
0.06132116913795471,
0.0375115... | -0.021032 |
member of the `owners` team. | | `:namespace` | The namespace of the module for which the test environment variable is being deleted. For private modules this is the same as the `:organization\_name` parameter. | | `:name` | The name of the module for which the test environment variable is being deleted. | | `:provider... | 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.014272200874984264,
0.059378594160079956,
-0.0672171339392662,
0.03183097019791603,
0.018002094700932503,
-0.047643281519412994,
0.017912842333316803,
-0.06121865659952164,
0.06701473891735077,
0.05408727377653122,
0.023399271070957184,
-0.041982702910900116,
0.029702430590987206,
0.030... | 0.075801 |
# Test configuration API Use the `/test-configuration` API endpoint to configure dynamic credentials for registry module tests. This API allows you to enable and manage OIDC authentication for module test runs, eliminating the need for static credentials. ## Configure dynamic credentials To configure dynamic credential... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/test-configuration.mdx | main | terraform | [
-0.12018992751836777,
0.0030802972614765167,
-0.09991148859262466,
0.03597600758075714,
-0.1015656366944313,
-0.015855152159929276,
0.0003658263594843447,
0.05899907648563385,
-0.03077322244644165,
0.060766443610191345,
0.007945499382913113,
-0.05853460356593132,
0.052074506878852844,
0.04... | -0.021838 |
"vault.workload.identity" } } } } ``` \*\*Vault Configuration Attributes:\*\* - `url` (string, required): The Vault instance URL - `role-name` (string, required): The name of the JWT auth role in Vault - `namespace` (string, optional): The Vault namespace (Vault Enterprise only) - `auth-path` (string, optional): The pa... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/test-configuration.mdx | main | terraform | [
-0.036153826862573624,
0.054672639816999435,
-0.05924202874302864,
0.022436872124671936,
0.016221236437559128,
-0.07544998824596405,
-0.03216470405459404,
-0.0006046549533493817,
0.08682379126548767,
-0.021238943561911583,
-0.049351390451192856,
-0.049575891345739365,
0.0512852817773819,
-... | -0.022845 |
"Module test token TTL must be between 300 and 1800 seconds", "source": { "pointer": "/data/attributes/module-test-token-ttl" } } ] } ``` ### Not found If the registry module doesn't exist: ```json { "errors": [ { "status": "404", "title": "Not Found", "detail": "Registry module not found" } ] } ``` ### Unauthorized If... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/test-configuration.mdx | main | terraform | [
-0.038090698421001434,
0.03544103726744652,
-0.06944435834884644,
0.016467565670609474,
-0.0222275760024786,
-0.02771027386188507,
-0.030866025015711784,
0.0642615482211113,
-0.03542676940560341,
-0.032253995537757874,
0.09651003777980804,
-0.025663157925009727,
-0.006993884686380625,
0.07... | 0.064475 |
[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 |
```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/hashicorp/registry-providers/private/hashicorp/aws/versions ``` ### Sample Response ```json { "data": { "id": "provver-y5KZU... | 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.0026896048802882433,
0.0570729561150074,
-0.039895929396152496,
-0.03594807907938957,
-0.004614717792719603,
-0.0597396194934845,
-0.06763362884521484,
-0.046536531299352646,
0.04672115296125412,
0.07403821498155594,
0.028731990605592728,
-0.07067734748125076,
-0.00370099232532084,
-0.01... | 0.04767 |
--request GET \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ https://app.terraform.io/api/v2/organizations/hashicorp/registry-providers/private/hashicorp/aws/versions/3.1.1 ``` ### Sample Response ```json { "data": { "id": "provver-y5KZUsSBRLV9zCtL", "type": "registry-pr... | 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.006703606806695461,
0.06273660063743591,
-0.045415930449962616,
-0.031646762043237686,
0.04314437136054039,
-0.0538204126060009,
-0.024883819743990898,
-0.048164255917072296,
0.053722918033599854,
0.0700235515832901,
0.028100881725549698,
-0.07229720801115036,
0.016145123168826103,
0.00... | 0.033015 |
provider platform. This endpoint only applies to private providers. | Status | Response | Reason | | ------- | ------------------------------------------------------------- | -------------------------------------------------------------- | | [201][] | [JSON API document][] (`type: "registry-provider-platforms"`) | Succ... | 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.08134625852108002,
0.05373052880167961,
-0.021476158872246742,
-0.03992171213030815,
-0.0005907193990424275,
-0.08369924128055573,
-0.03876281529664993,
-0.023046577349305153,
-0.0005596440751105547,
-0.008866586722433567,
0.02175554819405079,
-0.04072107747197151,
-0.029805628582835197,
... | 0.095034 |
"next-page": null, "total-pages": 1, "total-count": 2 } } } ``` \*\*Note:\*\* The `provider-binary-uploaded` property will be `false` if that file has not been uploaded to Archivist. In this case, instead of including a link to `provider-binary-download`, the response will include an upload link `provider-binary-upload... | 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.045786209404468536,
0.010912560857832432,
-0.03394382447004318,
0.021110398694872856,
-0.0021229053381830454,
0.001964723924174905,
-0.059655144810676575,
-0.008431094698607922,
0.014855488203465939,
0.06443767994642258,
0.05182082951068878,
-0.02994934283196926,
0.03065735474228859,
-0... | 0.017796 |
[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 [400]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400 [404]: https://developer.mozilla.org/en-US/docs/... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/queries/index.mdx | main | terraform | [
-0.045096538960933685,
0.0006415621028281748,
0.012682794593274593,
-0.03541349992156029,
-0.02271219529211521,
-0.10018382966518402,
-0.10176205635070801,
-0.09220628440380096,
0.00918811559677124,
0.02353793941438198,
0.02551814541220665,
0.04654669016599655,
0.003190860617905855,
0.0010... | 0.030111 |
{ "type": "users", "id": "user-123" } }, "canceled-by": { "data": null } }, "links": { "self": "/api/v2/queries/query-ABC123" } } } ``` ## List query runs for a workspace This endpoint lists query runs for a particular workspace. `GET /workspaces/:workspace\_id/queries` | Parameter | Description | |------------------|-... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/queries/index.mdx | main | terraform | [
-0.013305993750691414,
0.07144762575626373,
0.02523607388138771,
0.04920941963791847,
-0.06651556491851807,
0.01203463226556778,
-0.009259089827537537,
-0.04787378013134003,
0.028239013627171516,
0.05175091326236725,
-0.02297128550708294,
-0.0699966624379158,
0.03285658359527588,
-0.005987... | 0.02386 |
Status | Response | Reason | |---------|---------------------------|-----------------------------------------------------------------------| | [202][] | Empty body | Successfully canceled the query run. | | [409][] | [JSON API error object][] | Failed to transition query run to a canceled state. | ### Sample Request ``... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/queries/index.mdx | main | terraform | [
-0.04469286650419235,
0.08238201588392258,
0.01220736838877201,
0.035858795046806335,
-0.009008895605802536,
-0.08364884555339813,
-0.029135584831237793,
-0.04369593784213066,
0.06616988778114319,
0.09403647482395172,
0.021623244509100914,
-0.07586981356143951,
0.007976426742970943,
-0.011... | 0.026486 |
[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 documents]: /terraform/cloud-docs/api-docs#json-api-documents [JSON API error object]: https://jsonapi.... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-task-stages-and-results.mdx | main | terraform | [
-0.039210885763168335,
0.040626801550388336,
0.03351721912622452,
-0.012392889708280563,
-0.014130699448287487,
-0.03680389001965523,
-0.08242147415876389,
-0.04918128624558449,
0.05600558593869209,
0.03261880576610565,
-0.024762697517871857,
-0.06558792293071747,
0.02653314545750618,
0.04... | 0.027246 |
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/run-tasks/run-task-stages-and-results.mdx | main | terraform | [
-0.03818555921316147,
0.07242624461650848,
0.040880363434553146,
-0.00400567427277565,
-0.07181310653686523,
0.002760050119832158,
-0.08391503244638443,
-0.09009389579296112,
0.06811966001987457,
0.10846797376871109,
-0.04165146127343178,
-0.0483456514775753,
0.07353295385837555,
-0.049947... | -0.023988 |
Task Stage `POST /task-stages/:task\_stage\_id/actions/override` | Parameter | Description | | -------------------- | ----------------------------------------------------------------------------------------------- | | `:task\_stage\_id` | The ID of the task stage to override. | ### Sample Request ```shell curl \ --head... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-task-stages-and-results.mdx | main | terraform | [
-0.047169871628284454,
0.06590048968791962,
0.01397427637130022,
-0.02739892713725567,
-0.01682564988732338,
-0.058601319789886475,
-0.04053458198904991,
-0.014261479489505291,
0.03618759289383888,
0.10993122309446335,
-0.03388141468167305,
-0.05595261976122856,
0.005126637406647205,
-0.01... | 0.030088 |
[200]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200 [401]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401 [422]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422 [JSON API error object]: https://jsonapi.org/format/#error-objects # Run tasks integration API [Run tasks](/terrafor... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks-integration.mdx | main | terraform | [
-0.031506650149822235,
0.018096739426255226,
-0.004280367866158485,
-0.033794332295656204,
-0.04797213897109032,
-0.03961906209588051,
-0.06888885796070099,
-0.05666790157556534,
0.02916710264980793,
0.04141157120466232,
-0.05030439794063568,
-0.06402336806058884,
0.06800346821546555,
0.01... | 0.063739 |
`null` if the workspace does not have a VCS repository. | | `vcs\_commit\_url` | string | | URL to the commit that triggered this run. This is `null` if the workspace does not a VCS repository. | | `vcs\_pull\_request\_url` | string | | URL to the Pull Request/Merge Request that triggered this run. This is `null` if th... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks-integration.mdx | main | terraform | [
-0.04173002019524574,
-0.018786754459142685,
-0.003642100840806961,
0.01445764023810625,
-0.014541812241077423,
0.0017754610162228346,
0.007900508120656013,
-0.034098681062459946,
0.0427817739546299,
0.08455545455217361,
0.015394706279039383,
-0.15314677357673645,
-0.010603629052639008,
-0... | 0.048584 |
| [422][] | [JSON API error object][] | Invalid response payload. This could be caused by invalid attributes, or sending a status that is not accepted. | ### Request Body The PATCH request submits a JSON object with the following properties as a request payload. This payload is also described in the [JSON schema for ru... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks-integration.mdx | main | terraform | [
-0.028497129678726196,
0.04326380416750908,
0.03824716433882713,
0.001162096974439919,
-0.05742257088422775,
-0.09597902745008469,
-0.0742557942867279,
-0.07800816744565964,
-0.004952468443661928,
0.07746981829404831,
-0.012040405534207821,
-0.108838751912117,
0.007178650237619877,
0.01044... | 0.051779 |
MFA setting.\n—-- Payload truncated —--", "url": "https://external.service.dev/result/PRTNR-CC-TF-127" } } ``` ##### Complete Callback Payload Example The example below shows a complete payload explaining the data structure of a callback payload, including all the necessary fields. ```json { "data": { "type": "task-res... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks-integration.mdx | main | terraform | [
-0.06795560568571091,
0.040290411561727524,
0.014370744116604328,
0.003688468597829342,
0.04100790247321129,
-0.08241811394691467,
-0.048107463866472244,
-0.06297808140516281,
0.08021802455186844,
0.06101967766880989,
-0.004898080602288246,
-0.06929590553045273,
0.022205060347914696,
0.048... | 0.002757 |
[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-tasks/run-tasks.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 { "data": { "type": "tasks", "attributes": { "name": "example", "url": "http://example.com", "description": "Simple description", "hmac\_key": "secret", "enabled": "true", "category": "task", "global-configuration": { "enabled": true, "stages": ["pre\_plan"], "enforcement-level": "mandatory" } }, "relationships... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx | main | terraform | [
-0.03538518399000168,
0.07561922073364258,
-0.0037793440278619528,
-0.00879843533039093,
-0.021710941568017006,
-0.02557040937244892,
-0.03523963689804077,
-0.03074592351913452,
0.04187627136707306,
0.06211039051413536,
-0.01672610081732273,
-0.09823791682720184,
0.018479300662875175,
0.07... | 0.010481 |
\ https://app.terraform.io/api/v2/tasks/task-7oD7doVTQdAFnMLV ``` ### Sample Response ```json { "data": { "id": "task-7oD7doVTQdAFnMLV", "type": "tasks", "attributes": { "category": "task", "name": "my-task", "url": "http://example.com", "description": "Simple description", "enabled": "true", "hmac-key": null, }, "rela... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx | main | terraform | [
-0.039078790694475174,
0.04992583021521568,
0.06151007115840912,
0.025103852152824402,
-0.0012970893876627088,
-0.048441655933856964,
-0.06424591690301895,
-0.07829908281564713,
0.04366505518555641,
0.08141220360994339,
-0.024812232702970505,
-0.08443077653646469,
0.02500099129974842,
0.04... | -0.006549 |
| | `:id` | The ID of the run task to delete. Use the ["List Run Tasks"](#list-run-tasks) endpoint to find IDs. | | Status | Response | Reason | | ------- | ------------------------- | ---------------------------------------------------------- | | [204][] | No Content | Successfully deleted the run task | | [404][] | [... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx | main | terraform | [
-0.04742233455181122,
0.03462739288806915,
-0.057387687265872955,
-0.007604143116623163,
0.04131624102592468,
-0.05968967080116272,
0.0042535364627838135,
-0.04147692397236824,
0.07988755404949188,
0.08696896582841873,
-0.022125693038105965,
-0.03487127274274826,
0.04819624125957489,
0.022... | 0.085033 |
| | `:workspace\_id` | The workspace to list tasks for. | | Status | Response | Reason | | ------- | --------------------------------------- | ----------------------------------------------------------- | | [200][] | [JSON API document][] (`type: "tasks"`) | Request was successful | | [404][] | [JSON API error object][... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx | main | terraform | [
-0.051447611302137375,
0.03770386427640915,
-0.004870361182838678,
-0.00631823530420661,
-0.036734599620103836,
-0.009120476432144642,
-0.021380212157964706,
-0.052189525216817856,
0.031024303287267685,
0.057998061180114746,
-0.005188422743231058,
-0.06378999352455139,
0.04668459668755531,
... | 0.061227 |
`"mandatory"`. | | `data.attributes.stage` | string | (previous value) | \*\*DEPRECATED\*\* Use `stages` instead. The stage in the run lifecycle when the run task should begin. Must be `"pre\_plan"` or `"post\_plan"`. | | `data.attributes.stages` | array | (previous value) | An array of strings representing the stages ... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx | main | terraform | [
-0.010674316436052322,
0.08407105505466461,
0.03388189151883125,
0.01589098945260048,
-0.019752584397792816,
0.0034435447305440903,
-0.05808798596262932,
0.02371315471827984,
0.006448940373957157,
-0.023625900968909264,
-0.03007681854069233,
-0.053221870213747025,
-0.0037674885243177414,
0... | -0.00007 |
[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/hold-your-own-key/key-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 |
```json { "data": { "id": "keyv-emT4uwmo1B8B81Jt", "type": "hyok-customer-key-versions", "attributes": { "key-version": "3", "created-at": "2025-04-30T16:09:52.399Z", "status": "available", "error": null, "workspaces-secured": 0 }, "relationships": { "hyok-configuration": { "data": { "id": "hyokc-B4ae7Tzsy52QzMTA", "ty... | https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/docs/cloud-docs/api-docs/hold-your-own-key/key-versions.mdx | main | terraform | [
-0.025153201073408127,
0.14160478115081787,
0.01775100640952587,
0.006296794395893812,
-0.043506212532520294,
-0.03634696453809738,
-0.01212264597415924,
0.008231650106608868,
0.010825452394783497,
-0.039768751710653305,
0.06328541040420532,
-0.04204237088561058,
0.00945932138711214,
0.000... | 0.019626 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.