> ## 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 GitHub installation

> Check that the GitHub App is installed on a repository and holds the permissions Kaneo needs. Always 200 -- problems are reported in the body so the client can guide the user.



## OpenAPI

````yaml /openapi.json post /github-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:
  /github-integration/verify:
    post:
      tags:
        - GitHub
      summary: Verify GitHub installation
      description: >-
        Check that the GitHub App is installed on a repository and holds the
        permissions Kaneo needs. Always 200 -- problems are reported in the body
        so the client can guide the user.
      operationId: verifyGitHubInstallation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                projectId:
                  type: string
                  minLength: 1
                repositoryOwner:
                  type: string
                  minLength: 1
                repositoryName:
                  type: string
                  minLength: 1
              required:
                - projectId
                - repositoryOwner
                - repositoryName
      responses:
        '200':
          description: Verification result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GitHubVerificationResult'
        '400':
          description: Invalid body, or unknown project
          content:
            text/plain:
              schema:
                type: string
        '401':
          description: Missing or invalid credentials
        '403':
          description: No workspace access, or missing workspace:manage_settings
          content:
            text/plain:
              schema:
                type: string
components:
  schemas:
    GitHubVerificationResult:
      type: object
      properties:
        isInstalled:
          type: boolean
        installationId:
          type:
            - number
            - 'null'
        repositoryExists:
          type:
            - boolean
            - 'null'
        repositoryPrivate:
          type:
            - boolean
            - 'null'
        permissions:
          type:
            - object
            - 'null'
          additionalProperties:
            type: string
          description: The permissions the installation currently grants.
        hasRequiredPermissions:
          type: boolean
        missingPermissions:
          type: array
          items:
            type: string
          description: Permissions that must be granted before the link will work.
        message:
          type: string
          description: A human-readable summary to show the user.
        settingsUrl:
          type: string
          description: Where to adjust the installation, when one exists.
        installationUrl:
          type: string
          description: Where to install the App, when it is not installed yet.
      required:
        - isInstalled
        - installationId
        - repositoryExists
        - repositoryPrivate
        - permissions
        - hasRequiredPermissions
        - missingPermissions
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or session token (Bearer)

````