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

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

PreviousMethods NextOrganization

Last updated 1 year ago

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();

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();

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

{
  "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"
    }
  ]
}