GitLab

Verify GitLab access

Changed on

Check that the base URL is a GitLab instance and that the token can reach the project with the permissions Kaneo needs. An unreachable instance, a missing project, or insufficient permissions are reported in a 200 body so the form can explain them; a token GitLab rejects outright is a 401.

post/gitlab-integration/verify

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/gitlab-integration/verify
  • Auth
    HTTP bearer

Request body

projectIdstring required
baseUrlstring uri required
accessTokenstring required
tokenType'private' | 'bearer'

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.

projectPathstring required

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

Response

Verification result

isInstalledboolean required

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

hasRequiredPermissionsboolean required
projectExistsboolean required
projectVisibilitystring nullable required
missingPermissionsstring[] required
messagestring required

A human-readable summary to show the user.

failureReason'not_a_gitlab_instance' | 'redirected' | 'project_not_found' | 'null' nullable required

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

Changes

  • c9984766c765Revision changes
    • info

      added the non-success response with the status

  • c7b8a842601bRevision changes
    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status