Variables
This endpoint is used to create, update, search or delete variables information inside a Terrakube workspace.
To use this endpoint you should have "manageWorkspace" access at team level and a Terrakube workspace
Entity fields:
Path | Type | Description |
---|---|---|
data.type | string | Should be "variable" |
data.attributes.key | string | Unique variable name |
data.attributes.value | string | Key value |
data.attributes.sensitive | boolean | To hide the value when the output is sensitive |
data.attributes.hcl | boolean | Terraform HCL variable type |
data.attributes.category | string | Variable type could be TERRAFORM or ENV (Environment Variable) |
data.attributes.description | string | Free text |
Example:
Supported Operations
Returns an instance of type variable
workspace Identifier
variable Identifier
Successful response
Included resources
Creates an item of type variable and adds it to variable
workspace Identifier
Successful response
Deletes an instance of type vcs
workspace Identifier
vcs Identifier
Successful response
Modifies an instance of type vcs
workspace Identifier
vcs Identifier
Successful response
For a complete list of organization operation please visit the OpenAPI specification