GitLab Knowledge graph API

openapi: 3.2.0
info:
  title: GitLab REST Knowledge graph API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: Knowledge graph
  description: 'Use this API to list the namespaces enabled for the knowledge graph, and to enable or disable an

    individual namespace.


    These endpoints require administrator access to the instance.'
  x-displayName: Knowledge graph
paths:
  /api/v4/admin/knowledge_graph/namespaces:
    get:
      operationId: getApiV4AdminKnowledgeGraphNamespaces
      summary: Get all enabled namespaces for Knowledge Graph
      description: This endpoint retrieves all namespaces that have Knowledge Graph enabled
      tags:
      - Knowledge graph
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesAnalyticsKnowledgeGraphEnabledNamespace'
        '400':
          description: 400 Bad Request
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
      x-gitlab-tier: premium
  /api/v4/admin/knowledge_graph/namespaces/{id}:
    put:
      operationId: putApiV4AdminKnowledgeGraphNamespacesId
      summary: Enable a namespace for Knowledge Graph
      description: This endpoint enables Knowledge Graph for a specific namespace
      tags:
      - Knowledge graph
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesAnalyticsKnowledgeGraphEnabledNamespace'
        '400':
          description: 400 Bad Request
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Not found
        '503':
          description: 503 Service Unavailable
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the namespace.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      x-gitlab-tier: premium
    delete:
      operationId: deleteApiV4AdminKnowledgeGraphNamespacesId
      summary: Disable a namespace for Knowledge Graph
      description: This endpoint disables Knowledge Graph for a specific namespace
      tags:
      - Knowledge graph
      responses:
        '204':
          description: No Content
        '400':
          description: 400 Bad Request
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Not found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the namespace.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      x-gitlab-tier: premium
components:
  schemas:
    APIEntitiesAnalyticsKnowledgeGraphEnabledNamespace:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1234
        root_namespace_id:
          type: integer
          format: int64
          example: 5678
        created_at:
          type: string
          format: date-time
          example: '2025-01-01T00:00:00Z'
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header