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

PreviousMethods NextOrganization

Last updated 1 year ago

Was this helpful?

get

Returns the relationship globalvar

Path parameters

organizationIdanyRequired

organization Identifier

Query parameters

filter[globalvar]stringOptional

Filters the collection of globalvar using a 'disjoint' RSQL expression

page[number]integerOptional

Number of pages to return. Can be used with page[size]

page[size]integerOptional

Number of elements per page. Can be used with page[number]

page[offset]integerOptional

Offset from 0 to start paginating. Can be used with page[limit]

page[limit]integerOptional

Maximum number of items to return. Can be used with page[offset]

page[totals]stringOptional

For requesting total pages/records be included in the response page meta data

Responses

200

Successful response

application/vnd.api+json

get

GET /api/v1/organization/{organizationId}/globalvar HTTP/1.1
Host: 
Accept: */*

200

Successful response

{
  "data": [],
  "included": [
    {
      "attributes": {},
      "id": "text",
      "relationships": {},
      "type": "text"
    }
  ]
}

post

Creates an item of type globalvar and adds it to globalvar

Path parameters

organizationIdanyRequired

organization Identifier

Body

Responses

201

Successful response

application/vnd.api+json

post

POST /api/v1/organization/{organizationId}/globalvar HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 220

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

201

Successful response

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

patch

Modifies an instance of type globalvar

Path parameters

organizationIdanyRequired

organization Identifier

globalvarIdanyRequired

globalvar Identifier

Body

Responses

204

Successful response

patch

PATCH /api/v1/organization/{organizationId}/globalvar/{globalvarId} HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 220

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

204

Successful response

No content