Globalvar

This endpoint is used to create, update, search or delete global variables information inside a Terrakube organizations, this variables will be injected inside the jobs, workspace variables have priority over global variables if the same name is used.

You need to be part of the administrator Active Directory Group to work with this endpoint

Entity fields:

PathTypeDescription

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": "globalvar",
    "attributes": {
      "key": "tag_name",
      "value": "HolaMundo",
      "sensitive": false,
      "hcl": false,
      "category": "TERRAFORM",
      "description": "Azure RG Tag"
    }
  }
}

Supported Operations

For a complete list of organization operation please visit the OpenAPI specification

Last updated