> ## Documentation Index
> Fetch the complete documentation index at: https://kaneo.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Verify GitLab access

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



## OpenAPI

````yaml /openapi.json post /gitlab-integration/verify
openapi: 3.1.0
info:
  title: Kaneo API
  version: 1.0.0
  description: Kaneo Project Management API - Manage projects, tasks, labels, and more
servers:
  - url: https://cloud.kaneo.app/api
    description: Kaneo API Server
security:
  - bearerAuth: []
paths:
  /gitlab-integration/verify:
    post:
      tags:
        - GitLab
      summary: Verify GitLab access
      description: >-
        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.
      operationId: verifyGitlabAccess
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                projectId:
                  type: string
                  minLength: 1
                baseUrl:
                  type: string
                  format: uri
                accessToken:
                  type: string
                  minLength: 1
                tokenType:
                  type: string
                  enum:
                    - private
                    - bearer
                  description: >-
                    `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`.
                projectPath:
                  type: string
                  minLength: 1
                  description: >-
                    Full path of the GitLab project, including any nested
                    groups, for example acme/platform/web.
              required:
                - projectId
                - baseUrl
                - accessToken
                - projectPath
      responses:
        '200':
          description: Verification result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GitlabVerificationResult'
        '400':
          description: Invalid body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: GitLab rejected the token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: No access to the project, or missing workspace:manage_settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Project not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          $ref: '#/components/responses/ApiKeyRateLimited'
components:
  schemas:
    GitlabVerificationResult:
      type: object
      properties:
        isInstalled:
          type: boolean
          description: The base URL answered as a GitLab instance for this token.
        hasRequiredPermissions:
          type: boolean
        projectExists:
          type: boolean
        projectVisibility:
          type:
            - string
            - 'null'
        missingPermissions:
          type: array
          items:
            type: string
        message:
          type: string
          description: A human-readable summary to show the user.
        failureReason:
          type:
            - string
            - 'null'
          enum:
            - not_a_gitlab_instance
            - redirected
            - project_not_found
            - null
          description: >-
            Why verification failed, when it did. `redirected` usually means the
            base URL is behind a proxy that rewrites it.
      required:
        - isInstalled
        - hasRequiredPermissions
        - projectExists
        - projectVisibility
        - missingPermissions
        - message
        - failureReason
    ApiError:
      type: object
      properties:
        message:
          type: string
          description: Human-readable description of the error.
          example: Task not found
        code:
          type: string
          description: >-
            Stable UPPER_SNAKE_CASE code. Derived from the status unless a more
            specific code applies, such as VALIDATION_ERROR or
            MISSING_PERMISSION.
          example: NOT_FOUND
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
                description: >-
                  Dotted path to the invalid input, prefixed with the request
                  part (body, query, params, header).
                example: body.title
              message:
                type: string
                example: Required
            required:
              - path
              - message
          description: Every validation issue, for VALIDATION_ERROR.
        missingPermissions:
          type: array
          items:
            type: string
          description: >-
            Permissions the caller lacks for this route, as resource:action, for
            MISSING_PERMISSION and API_KEY_SCOPE.
          example:
            - task:update
      required:
        - message
        - code
  responses:
    ApiKeyRateLimited:
      description: >-
        The API key exceeded its rate limit or usage quota. Wait the number of
        seconds in Retry-After before retrying. The X-RateLimit headers are sent
        only when the rate limit was hit.
      headers:
        Retry-After:
          description: >-
            Seconds to wait before retrying. Omitted when an exhausted usage
            quota never refills.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Requests the API key may make per window.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests left in the current window.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: Unix time in seconds when the current window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or session token (Bearer)

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.