1 of 1

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

Example:

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

Supported Operations

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

Vcs

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

Entity fields:

Path

Type

Description

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

fields[vcs]array of enum

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

itemsenum

accessTokenclientIdclientSecretdescriptionnamevcsTypeorganization

includearray of enum

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

itemsenum

organization

Response

Successful response

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

includedarray of object

Included resources

attributesobject

idstring

relationshipsobject

typestring

Request

Response

Creates an item of type vcs and adds it to vcs

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

Path parameters

organizationId*string

organization 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

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

Request

Response

Deletes an instance of type vcs

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

Path parameters

organizationId*string

organization Identifier

vcsId*string

vcs Identifier

Response

Successful response

Request

Modifies an instance of type vcs

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

Path parameters

organizationId*string

organization 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/organization/{organizationId}/vcs/{vcsId}

Path parameters

organizationId*string

organization Identifier

vcsId*string

vcs Identifier

Response

Successful response

Request

Modifies an instance of type vcs

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

Path parameters

organizationId*string

organization 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

Creates an item of type vcs and adds it to vcs

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

Path parameters

organizationId*string

organization 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

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

Request

Response

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

fields[vcs]array of enum

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

itemsenum

accessTokenclientIdclientSecretdescriptionnamevcsTypeorganization

includearray of enum

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

itemsenum

organization

Response

Successful response

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

includedarray of object

Included resources

attributesobject

idstring

relationshipsobject

typestring

Request

Response

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

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

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

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

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

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