Generate VCS token | Integrations | Northflank API docs
v1
Double column
API
CLI
JS Client

Integrations /

Generate VCS token

Generate a token for a specific VCS link.

Required permission

Account > Git > Tokens > Read

Path parameters

    • customVCSId

      string required

      ID of the custom VCS

    • vcsLinkId

      string required

      ID of the version control link

Query parameters

    • force_refresh

      boolean

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

      • vcsService

        string required

        VCS provider the token belongs to.

        one of
        bitbucket, gitlab, github, self-hosted
      • installationId

        integer

        Installation ID of the GitHub installation the token belongs to (GitHub only)

      • installationToken

        string

        Installation token (GitHub only).

      • token

        string required

        OAuth token.

API
CLI
JS Client

POST /v1/integrations/vcs/custom/{customVCSId}/token/{vcsLinkId}

Example response

200 OK

A version control access token for the provided link.

JSON

{
  "data": {
    "vcsService": "github",
    "installationId": 1234567,
    "installationToken": "ghs_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "token": "ghu_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

© 2024 Northflank Ltd. All rights reserved.