Comment on page

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:
{
  "data": {
    "type": "variable",
    "attributes": {
      "key": "tag_name",
      "value": "HolaMundo",
      "sensitive": false,
      "hcl": false,
      "category": "TERRAFORM",
      "description": "Azure RG Tag"
    }
  }
}
Supported Operations
get
/workspace/{workspaceId}/variable/{variableId}
post
/workspace/{workspaceId}/variable
delete
/workspace/{workspaceId}/vcs/{vcsId}
patch
/workspace/{workspaceId}/vcs/{vcsId}
For a complete list of organization operation please visit the OpenAPI specification​

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

Workspace

History

Last modified 1yr ago