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

Returns an instance of type vcs

Path parameters

organizationIdstringRequired

organization Identifier

vcsIdstringRequired

vcs Identifier

Query parameters

Responses

200

Successful response

application/vnd.api+json

get

/organization/{organizationId}/vcs/{vcsId}

HTTPcURLJavaScriptPython

GET /api/v1/organization/{organizationId}/vcs/{vcsId} HTTP/1.1
Host: 
Accept: */*

200

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "accessToken": null,
      "apiUrl": null,
      "callback": null,
      "clientId": null,
      "clientSecret": null,
      "connectionType": null,
      "createdBy": null,
      "createdDate": null,
      "description": null,
      "endpoint": null,
      "name": null,
      "privateKey": null,
      "redirectUrl": null,
      "status": null,
      "updatedBy": null,
      "updatedDate": null,
      "vcsType": null
    },
    "relationships": {
      "organization": {
        "data": [
          null
        ]
      },
      "workspace": {
        "data": [
          null
        ]
      }
    }
  },
  "included": [
    {
      "type": "text",
      "id": "text",
      "attributes": {},
      "relationships": {}
    }
  ]
}

post

Creates an item of type vcs and adds it to vcs

Path parameters

organizationIdstringRequired

organization Identifier

Body

application/vnd.api+json

Responses

201

Successful response

application/vnd.api+json

post

/organization/{organizationId}/vcs

HTTPcURLJavaScriptPython

POST /api/v1/organization/{organizationId}/vcs HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 235

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

201

Successful 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"
      }
    }
  }
}

delete

Deletes an instance of type vcs

Path parameters

organizationIdstringRequired

organization Identifier

vcsIdstringRequired

vcs Identifier

Responses

204

Successful response

delete

/organization/{organizationId}/vcs/{vcsId}

HTTPcURLJavaScriptPython

DELETE /api/v1/organization/{organizationId}/vcs/{vcsId} HTTP/1.1
Host: 
Accept: */*

204

Successful response

No content

patch

Modifies an instance of type vcs

Path parameters

organizationIdstringRequired

organization Identifier

vcsIdstringRequired

vcs Identifier

Body

application/vnd.api+json

Responses

204

Successful response

patch

/organization/{organizationId}/vcs/{vcsId}

HTTPcURLJavaScriptPython

PATCH /api/v1/organization/{organizationId}/vcs/{vcsId} HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 235

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

Successful response

No content

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