List VCS providers

Lists linked version control providers

Required permission

Account > Git > General > Read

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
min
1
max
100
page
integer
The page number to access.
min
1
cursor
string
The cursor returned from the previous page of results, used to request the next page.
min length
24
max length
24

Response body

{object}
Response object.

data
{object} required
Result data.

vcsAccountLinks
[array] required
The version control accounts linked to this Northflank account.

{object}
Details about the linked version control account.

vcsService
string required
The type of version control provider the account is linked to.
one of
bitbucket, gitlab, github, self-hosted, azure, origin
email
(multiple options: oneOf)
The email of the account linked with this provider.

login
string required
The username of the account linked with this provider.
vcsLinkId
string required
The ID of this linked version control account. Pass this value as `vcsLinkId` when creating a harness or service from this account.
alias
string
A user-defined alias for the linked version control account, if set.
name
string
The name of the version control provider. Only returned for self-hosted links.
vcsUrl
string
The url of the version control provider. Only returned for self-hosted links.
vcsType
string
The type of the self-hosted vcs provider. Only returned for self-hosted links.
one of
gitlab-ee, github-ghe, gitea
internalId
string
The ID of the self-hosted vcs provider. Only returned for self-hosted links.
entityName
string
The name of the team the self-hosted vcs belongs to. Only returned for self-hosted links.
originTargetSlug
string
The Cursor Origin installation target slug.
originRepoSelectionMode
string
Whether the Origin installation grants all or selected repositories.
one of
all, selected
originScopes
[array]
The repository scopes granted to the Origin installation.

string

originMissingScopes
[array]
The Origin scopes required for full Northflank functionality but not granted.

string

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.

GET /v1/integrations/vcs

GET /v1/teams/{teamId}/integrations/vcs

Example response

200 OK

Details about the version control providers available for use.

JSON

{
  "data": {
    "vcsAccountLinks": [
      {
        "vcsService": "self-hosted",
        "login": "vcs-user",
        "vcsLinkId": "63ebb6ce2ccc6c7affdbf253",
        "alias": "my-github",
        "name": "Self-hosted VCS",
        "vcsUrl": "https://git.example.com",
        "vcsType": "gitlab-ee",
        "internalId": "example-team/self-hosted-vcs",
        "entityName": "Example Team",
        "originTargetSlug": "example-team"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}