Check repository access

Checks whether a git repository is publicly reachable or accessible via one of your linked version control accounts, before creating a resource that would clone it.

Required permission

Account > Git > General > Read

Request body

{object}

projectUrl
string required
HTTPS URL of the git repository to check access for.
projectType
string required
The version control provider the repository belongs to.
one of
bitbucket, gitlab, github, self-hosted, azure, origin
projectBranch
string
Optional branch to check.
vcsLinkId
string
If provided, only checks access via this specific linked account.
min length
24
max length
24
accountLogin
string
If provided, only checks access via the linked account with this login.
selfHostedVcsId
(multiple options: oneOf)
The self-hosted provider document ID, internalId, or team/internalId. Required for self-hosted repositories unless vcsLinkId identifies the provider.

(multiple options: oneOf)

Response body

{object}
Response object.

data
{object} required
Result data.

publicRepo
boolean required
Whether the repository is publicly reachable without a linked account.
accessible
boolean required
Whether the repository can be accessed — publicly or via a linked account.
vcsLinkId
string
The linked account that can access the repository. Present when `reason` is `linked-account`.
accountLogin
string
Login of the linked account that can access the repository. Present when `reason` is `linked-account`.
reason
string required
Why the repository is (in)accessible: `public` (reachable anonymously), `linked-account` (a linked account can access it), `no-linked-access` (no linked account can access it), or `not-found` (the repository URL does not resolve).
one of
public, linked-account, no-linked-access, not-found

API

CLI

JS Client

POST /v1/integrations/vcs/repo-access

POST /v1/teams/{teamId}/integrations/vcs/repo-access

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"projectUrl":"https://github.com/northflank-examples/next-js-example","projectType":"github","projectBranch":"main","accountLogin":"example-user"}' \
  https://api.northflank.com/v1/integrations/vcs/repo-access

Example response

200 OK

The access status of the repository.

JSON

{
  "data": {
    "publicRepo": false,
    "accessible": true,
    "vcsLinkId": "63ebb6ce2ccc6c7affdbf253",
    "accountLogin": "example-user",
    "reason": "linked-account"
  }
}