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

# Create GitLab integration

> Link a project to a GitLab project. Kaneo generates the secret GitLab must send with each webhook; add the webhook in GitLab afterwards. Use the verify route first to confirm the token really reaches the project.



## OpenAPI

````yaml /openapi.json post /gitlab-integration/project/{projectId}
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/project/{projectId}:
    post:
      tags:
        - GitLab
      summary: Create GitLab integration
      description: >-
        Link a project to a GitLab project. Kaneo generates the secret GitLab
        must send with each webhook; add the webhook in GitLab afterwards. Use
        the verify route first to confirm the token really reaches the project.
      operationId: createGitlabIntegration
      parameters:
        - schema:
            type: string
          required: true
          name: projectId
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                baseUrl:
                  type: string
                  format: uri
                accessToken:
                  type: string
                  description: >-
                    Omit to keep the stored token only when the GitLab base URL
                    is unchanged. A changed URL requires a new token.
                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
              required:
                - baseUrl
                - projectPath
      responses:
        '200':
          description: The stored integration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GitlabIntegration'
        '400':
          description: Invalid body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Missing or invalid credentials
          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'
        '409':
          description: That GitLab project is already linked to another Kaneo project
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          $ref: '#/components/responses/ApiKeyRateLimited'
components:
  schemas:
    GitlabIntegration:
      type:
        - object
        - 'null'
      properties:
        id:
          type: string
        projectId:
          type: string
        baseUrl:
          type: string
          description: Root URL of the GitLab instance.
        projectPath:
          type: string
          description: Full path of the linked project, nested groups included.
        tokenType:
          type: string
          enum:
            - private
            - bearer
        maskedAccessToken:
          type: string
          description: >-
            First and last characters of the stored token, only returned to
            callers with workspace:manage_settings.
        webhookUrl:
          type: string
          description: Where GitLab should POST events for this project.
        webhookSecret:
          type: string
          description: >-
            Only returned to callers with workspace:manage_settings, so the
            value can be pasted into GitLab.
        branchPattern:
          type: string
        commentTaskLinkOnGitlabIssue:
          type: boolean
          description: >-
            When on, Kaneo comments a link back to the task on each issue opened
            in GitLab. Issues Kaneo creates from tasks are not commented on.
        isActive:
          type:
            - boolean
            - 'null'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - projectId
        - baseUrl
        - projectPath
        - tokenType
        - maskedAccessToken
        - isActive
        - createdAt
        - updatedAt
    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.