v1
Double column
API
CLI
JS Client

Integrations /

List VCS providers

Lists linked version control providers

Required permission

Account > Git > General > Read

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
          • email

            string required

            The email of the account linked with this provider.

          • login

            string required

            The username of the account linked with this provider.

          • 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
          • 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.

API
CLI
JS Client

GET /v1/vcs

Example response

200 OK

Details about the version control providers available for use.

JSON

{
  "data": {
    "vcsAccountLinks": [
      {
        "vcsService": "self-hosted",
        "email": "email@example.com",
        "login": "vcs-user",
        "name": "Self-hosted VCS",
        "vcsUrl": "https://git.example.com",
        "vcsType": "gitlab-ee",
        "internalId": "example-team/self-hosted-vcs",
        "entityName": "Example Team"
      }
    ]
  }
}

© 2022 Northflank Ltd. All rights reserved.