Create A Variable

Create a new variable in a specified workspace.

External Documentation

To learn more, visit the Terraform Cloud documentation.

​

Parameters

Parameter	Description
Category	Whether this is a Terraform or environment variable.
Description	An optional description for the variable (mainly for readability purposes).
HCL	Whether to evaluate the value of the variable as a string of HCL code. Has no effect for environment variables.
Sensitive	Whether the value is sensitive. If true then the variable is written once and not visible thereafter.
Variable Key	The key of the new variable.
Variable Value	The value of the new variable.
Workspace ID	Specifies 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"
		}
	}
}