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
| Path | Type | Description |
|---|---|---|
For a complete list of organization operation please visit the OpenAPI specification
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
Returns the relationship globalvar
organization Identifier
Sorts the collection on the selected attributes. A prefix of '-' sorts descending
Selects the set of globalvar fields that should be returned in the result.
Selects the set of relationships that should be expanded as a compound document in the result.
Filters the collection of globalvar using a 'disjoint' RSQL expression
Number of pages to return. Can be used with page[size]
Number of elements per page. Can be used with page[number]
Offset from 0 to start paginating. Can be used with page[limit]
Maximum number of items to return. Can be used with page[offset]
For requesting total pages/records be included in the response page meta data
Successful response
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (admin update secret)
Read Permissions : (admin read secret) Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Included resources
Deletes an instance of type globalvar
organization Identifier
globalvar Identifier
Successful response
Modifies an instance of type globalvar
organization Identifier
globalvar Identifier
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (admin update secret)
Read Permissions : (admin read secret) Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Successful response
Creates an item of type globalvar and adds it to globalvar
organization Identifier
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (admin update secret)
Read Permissions : (admin read secret) Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Successful response
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (admin update secret)
Read Permissions : (admin read secret) Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)