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:

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

Supported Operations

Returns the relationship globalvar

GET/api/v1/organization/{organizationId}/globalvar

Path parameters

organizationId*string

organization Identifier

Query parameters

Response

200

Successful response

Body

application/vnd.api+json

dataarray of globalvar (object)

includedarray of object

Included resources

Request

JavaScriptCurl

const response = await fetch('/api/v1/organization/{organizationId}/globalvar', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "type": "text",
      "id": "text",
      "attributes": {
        "category": "TERRAFORM",
        "description": "text",
        "hcl": false,
        "key": "text",
        "sensitive": false,
        "value": "text"
      },
      "relationships": {
        "organization": {
          "id": "text",
          "type": "organization"
        }
      }
    }
  ],
  "included": [
    {
      "id": "text",
      "type": "text"
    }
  ]
}

Creates an item of type globalvar and adds it to globalvar

POST/api/v1/organization/{organizationId}/globalvar

Path parameters

organizationId*string

organization Identifier

Body

application/vnd.api+json

dataglobalvar (object)

Response

201

Successful response

Body

application/vnd.api+json

dataglobalvar (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/organization/{organizationId}/globalvar', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "category": "TERRAFORM",
      "description": "text",
      "hcl": false,
      "key": "text",
      "sensitive": false,
      "value": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  }
}

Deletes an instance of type globalvar

DELETE/api/v1/organization/{organizationId}/globalvar/{globalvarId}

Path parameters

organizationId*string

organization Identifier

globalvarId*string

globalvar Identifier

Response

204

Successful response

Request

JavaScriptCurl

const response = await fetch('/api/v1/organization/{organizationId}/globalvar/{globalvarId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Modifies an instance of type globalvar

PATCH/api/v1/organization/{organizationId}/globalvar/{globalvarId}

Path parameters

organizationId*string

organization Identifier

globalvarId*string

globalvar Identifier

Body

application/vnd.api+json

dataglobalvar (object)

Response

204

Successful response

Request

JavaScriptCurl

const response = await fetch('/api/v1/organization/{organizationId}/globalvar/{globalvarId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

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