Skip to main content
POST
Verify GitLab access

Authorizations

Authorization
string
header
required

API key or session token (Bearer)

Body

application/json
projectId
string
required
Minimum string length: 1
baseUrl
string<uri>
required
accessToken
string
required
Minimum string length: 1
projectPath
string
required

Full path of the GitLab project, including any nested groups, for example acme/platform/web.

Minimum string length: 1
tokenType
enum<string>

private sends the token in PRIVATE-TOKEN, which is what personal, project and group access tokens expect. bearer sends it in Authorization, for an OAuth2 token you already hold. Defaults to private.

Available options:
private,
bearer

Response

Verification result

isInstalled
boolean
required

The base URL answered as a GitLab instance for this token.

hasRequiredPermissions
boolean
required
projectExists
boolean
required
projectVisibility
string | null
required
missingPermissions
string[]
required
message
string
required

A human-readable summary to show the user.

failureReason
enum<string> | null
required

Why verification failed, when it did. redirected usually means the base URL is behind a proxy that rewrites it.

Available options:
not_a_gitlab_instance,
redirected,
project_not_found,
null