Skip to main content
Create a new variable in a specified workspace.
External DocumentationTo learn more, visit the Terraform Cloud documentation.

​
Parameters

ParameterDescription
CategoryWhether this is a Terraform or environment variable.
DescriptionAn optional description for the variable (mainly for readability purposes).
HCLWhether to evaluate the value of the variable as a string of HCL code. Has no effect for environment variables.
SensitiveWhether the value is sensitive. If true then the variable is written once and not visible thereafter.
Variable KeyThe key of the new variable.
Variable ValueThe value of the new variable.
Workspace IDSpecifies the workspace ID where the var will be created.

​
Example Output

{
	"data": {
		"id": "var-EavQ1LztoRTQHSNT",
		"type": "vars",
		"attributes": {
			"key": "some_key",
			"value": "some_value",
			"sensitive": false,
			"category": "terraform",
			"hcl": false,
			"created-at": "2023-04-03T18:47:13",
			"description": "some description",
			"version-id": "<string>"
		},
		"relationships": {
			"configurable": {
				"data": {
					"id": "ws-4j8p6jX1w33MiDC7",
					"type": "workspaces"
				},
				"links": {
					"related": "/api/v2/organizations/my-organization/workspaces/my-workspace"
				}
			},
			"workspace": {
				"data": {
					"id": "<string>",
					"type": "<string>"
				},
				"links": {
					"related": "<string>"
				}
			}
		},
		"links": {
			"self": "/api/v2/vars/var-EavQ1LztoRTQHSNT"
		}
	}
}

​
Workflow Library Example

Create a Variable with Terraform Cloud and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop