Terrakube
Latest
Search
K
Comment on page

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

get
/organization/{organizationId}/vcs/{vcsId}
post
/organization/{organizationId}/vcs
delete
/organization/{organizationId}/vcs/{vcsId}
patch
/organization/{organizationId}/vcs/{vcsId}
For a complete list of organization operation please visit the OpenAPI specification
Last modified 1yr ago