1 of 1

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

Example:

{
  "data": {
    "type": "variable",
    "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

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

Example:

{
  "data": {
    "type": "variable",
    "attributes": {
      "key": "tag_name",
      "value": "HolaMundo",
      "sensitive": false,
      "hcl": false,
      "category": "TERRAFORM",
      "description": "Azure RG Tag"
    }
  }
}

Supported Operations

Returns an instance of type variable

GET/api/v1/workspace/{workspaceId}/variable/{variableId}

Path parameters

workspaceId*string

workspace Identifier

variableId*string

variable Identifier

Query parameters

fields[variable]array of enum

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

itemsenum

categorydescriptionhclkeysensitivevalueworkspace

includearray of enum

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

itemsenum

workspace

Response

Successful response

Body

datavariable (object)

typestring

idstring

attributesobject

categoryenum

TERRAFORMENV

descriptionstring

hclboolean

keystring

sensitiveboolean

valuestring

Read Permissions : (service read secret)

relationshipsobject

workspaceobject

idstring

typeenum

workspace

includedarray of object

Included resources

attributesobject

idstring

relationshipsobject

typestring

Request

Response

Creates an item of type variable and adds it to variable

POST/api/v1/workspace/{workspaceId}/variable

Path parameters

workspaceId*string

workspace Identifier

Body

datavariable (object)

typestring

idstring

attributesobject

categoryenum

TERRAFORMENV

descriptionstring

hclboolean

keystring

sensitiveboolean

valuestring

Read Permissions : (service read secret)

relationshipsobject

workspaceobject

idstring

typeenum

workspace

Response

Successful response

Body

datavariable (object)

typestring

idstring

attributesobject

categoryenum

TERRAFORMENV

descriptionstring

hclboolean

keystring

sensitiveboolean

valuestring

Read Permissions : (service read secret)

relationshipsobject

workspaceobject

idstring

typeenum

workspace

Request

Response

Deletes an instance of type vcs

DELETE/api/v1/workspace/{workspaceId}/vcs/{vcsId}

Path parameters

workspaceId*string

workspace Identifier

vcsId*string

vcs Identifier

Response

Successful response

Request

Modifies an instance of type vcs

PATCH/api/v1/workspace/{workspaceId}/vcs/{vcsId}

Path parameters

workspaceId*string

workspace Identifier

vcsId*string

vcs Identifier

Body

datavcs (object)

typestring

Create Permissions : (team manage vcs) Delete Permissions : (team manage vcs)

idstring

attributesobject

accessTokenstring

Read Permissions : (service read vcs secret) Update Permissions : (team manage vcs)

clientIdstring

Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)

clientSecretstring

Read Permissions : (service read vcs secret) Update Permissions : (team manage vcs)

descriptionstring

Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)

namestring

Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)

vcsTypeenum

Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)

GITHUBGITLABBITBUCKETAZURE_DEVOPSPUBLIC

relationshipsobject

organizationobject

Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)

idstring

typeenum

organization

Response

Successful response

Request

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

Deletes an instance of type vcs

DELETE/api/v1/workspace/{workspaceId}/vcs/{vcsId}

Path parameters

workspaceId*string

workspace Identifier

vcsId*string

vcs Identifier

Response

Successful response

Request

Creates an item of type variable and adds it to variable

POST/api/v1/workspace/{workspaceId}/variable

Path parameters

workspaceId*string

workspace Identifier

Body

datavariable (object)

typestring

idstring

attributesobject

categoryenum

TERRAFORMENV

descriptionstring

hclboolean

keystring

sensitiveboolean

valuestring

Read Permissions : (service read secret)

relationshipsobject

workspaceobject

idstring

typeenum

workspace

Response

Successful response

Body

datavariable (object)

typestring

idstring

attributesobject

categoryenum

TERRAFORMENV

descriptionstring

hclboolean

keystring

sensitiveboolean

valuestring

Read Permissions : (service read secret)

relationshipsobject

workspaceobject

idstring

typeenum

workspace

Request

Response

Modifies an instance of type vcs

PATCH/api/v1/workspace/{workspaceId}/vcs/{vcsId}

Path parameters

workspaceId*string

workspace Identifier

vcsId*string

vcs Identifier

Body

datavcs (object)

typestring

Create Permissions : (team manage vcs) Delete Permissions : (team manage vcs)

idstring

attributesobject

accessTokenstring

Read Permissions : (service read vcs secret) Update Permissions : (team manage vcs)

clientIdstring

Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)

clientSecretstring

Read Permissions : (service read vcs secret) Update Permissions : (team manage vcs)

descriptionstring

Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)

namestring

Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)

vcsTypeenum

Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)

GITHUBGITLABBITBUCKETAZURE_DEVOPSPUBLIC

relationshipsobject

organizationobject

Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)

idstring

typeenum

organization

Response

Successful response

Request

Returns an instance of type variable

GET/api/v1/workspace/{workspaceId}/variable/{variableId}

Path parameters

workspaceId*string

workspace Identifier

variableId*string

variable Identifier

Query parameters

fields[variable]array of enum

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

itemsenum

categorydescriptionhclkeysensitivevalueworkspace

includearray of enum

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

itemsenum

workspace

Response

Successful response

Body

datavariable (object)

typestring

idstring

attributesobject

categoryenum

TERRAFORMENV

descriptionstring

hclboolean

keystring

sensitiveboolean

valuestring

Read Permissions : (service read secret)

relationshipsobject

workspaceobject

idstring

typeenum

workspace

includedarray of object

Included resources

attributesobject

idstring

relationshipsobject

typestring

Request

Response

const response = await fetch('/api/v1/workspace/{workspaceId}/vcs/{vcsId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

const response = await fetch('/api/v1/workspace/{workspaceId}/variable', {
    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": {
      "workspace": {
        "id": "text",
        "type": "workspace"
      }
    }
  }
}

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

const response = await fetch('/api/v1/workspace/{workspaceId}/variable/{variableId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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