Vcs

This endpoint is used to create, update, search or delete vcs (version control system) information inside a Terrakube organization so you can connect to private git repositories to run modules and workspaces

To use this endpoint you should have "manageVcs" access at team level and a Terrakube Organization

Entity fields:

Path	Type	Description
data.type	string	Should be "vcs"
data.attributes.name	string	Unique vcs name for an Terrakube organization
data.attributes.description	string	Free text for description
data.attributes.vcsType	string	Supported values: GITHUB, GITLAB, BITBUCKET, AZURE_DEVOPS
data.attributes.clientID	string	Client Application Id
data.attributes.clientSecret	string	Client Application secret

Example:

{
  "data": {
    "type": "vcs",
    "attributes": {
      "name": "GitHubConnection",
      "description": "Private repositories inside GitHub",
      "vcsType": "GITHUB",
      "clientId": "{{githubClientId}}",
      "clientSecret": "{{githubClientSecret}}"
    }
  }
}

Supported Operations

Returns an instance of type vcs

GET/api/v1/organization/{organizationId}/vcs/{vcsId}

Path parameters

organizationId*string

organization Identifier

vcsId*string

vcs Identifier

Query parameters

Response

200

Successful response

Body

application/vnd.api+json

datavcs (object)

includedarray of object

Included resources

Request

JavaScriptCurl

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

Response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "accessToken": "text",
      "clientId": "text",
      "clientSecret": "text",
      "description": "text",
      "name": "text",
      "vcsType": "GITHUB"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  },
  "included": [
    {
      "id": "text",
      "type": "text"
    }
  ]
}

Creates an item of type vcs and adds it to vcs

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

Path parameters

organizationId*string

organization Identifier

Body

application/vnd.api+json

datavcs (object)

Response

201

Successful response

Body

application/vnd.api+json

datavcs (object)

Request

JavaScriptCurl

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

Response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "accessToken": "text",
      "clientId": "text",
      "clientSecret": "text",
      "description": "text",
      "name": "text",
      "vcsType": "GITHUB"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  }
}

Deletes an instance of type vcs

DELETE/api/v1/organization/{organizationId}/vcs/{vcsId}

Path parameters

organizationId*string

organization Identifier

vcsId*string

vcs Identifier

Response

204

Successful response

Request

JavaScriptCurl

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

Modifies an instance of type vcs

PATCH/api/v1/organization/{organizationId}/vcs/{vcsId}

Path parameters

organizationId*string

organization Identifier

vcsId*string

vcs Identifier

Body

application/vnd.api+json

datavcs (object)

Response

204

Successful response

Request

JavaScriptCurl

const response = await fetch('/api/v1/organization/{organizationId}/vcs/{vcsId}', {
    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