Variables

This endpoint is used to create, update, search or delete variables information inside a Terrakube workspace.

To use this endpoint you should have "manageWorkspace" access at team level and a Terrakube workspace

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

Supported Operations

get

Returns an instance of type variable

Path parameters

workspaceIdanyrequired

workspace Identifier

variableIdanyrequired

variable Identifier

Query parameters

fields[variable]anyoptional

Selects the set of variable fields that should be returned in the result.

includeanyoptional

Selects the set of relationships that should be expanded as a compound document in the result.

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspace/{workspaceId}/variable/{variableId}'

200

200

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

Successful response

post

Creates an item of type variable and adds it to variable

Path parameters

workspaceIdanyrequired

workspace Identifier

Body

dataobjectoptional

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspace/{workspaceId}/variable' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
    "data": {
      "type": "text",
      "id": "text",
      "attributes": {
        "category": "TERRAFORM",
        "description": "text",
        "hcl": true,
        "key": "text",
        "sensitive": true,
        "value": "text"
      },
      "relationships": {
        "workspace": {
          "id": "text",
          "type": "workspace"
        }
      }
    }
  }'

201

201

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

Successful response

delete

Deletes an instance of type vcs

Path parameters

workspaceIdanyrequired

workspace Identifier

vcsIdanyrequired

vcs Identifier

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/workspace/{workspaceId}/vcs/{vcsId}'

204

204

No body

Successful response

patch

Modifies an instance of type vcs

Path parameters

workspaceIdanyrequired

workspace Identifier

vcsIdanyrequired

vcs Identifier

Body

dataobjectoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/workspace/{workspaceId}/vcs/{vcsId}' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
    "data": {
      "type": "text",
      "id": "text",
      "attributes": {
        "accessToken": "text",
        "clientId": "text",
        "clientSecret": "text",
        "description": "text",
        "name": "text",
        "vcsType": "GITHUB"
      },
      "relationships": {
        "organization": {
          "id": "text",
          "type": "organization"
        }
      }
    }
  }'

204

204

No body

Successful response

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