GitLab Code search API

openapi: 3.2.0
info:
  title: GitLab REST Code search 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: Code search
  description: 'Use this API to administer the Zoekt nodes that power

    exact code search, including which

    namespaces each node indexes, replica overrides, and triggering indexing for a project.


    These endpoints require administrator access to the instance.'
  x-displayName: Code search
paths:
  /api/v4/admin/zoekt/projects/{project_id}/index:
    put:
      operationId: putApiV4AdminZoektProjectsProjectIdIndex
      summary: Triggers indexing for the specified project
      description: Triggers background indexing of the specified project using the Zoekt search engine.
      tags:
      - Code search
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesSearchZoektProjectIndexSuccess'
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Not found
        '400':
          description: Bad Request
      parameters:
      - name: project_id
        required: true
        description: ID of the project to index.
        schema:
          type: integer
        in: path
  /api/v4/admin/zoekt/namespaces/{id}:
    patch:
      operationId: patchApiV4AdminZoektNamespacesId
      summary: Update the number of replicas override for an enabled namespace
      description: Updates the replication factor override for a namespace enabled in the Zoekt search engine.
      tags:
      - Code search
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesSearchZoektIndexedNamespace'
        '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
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/patchApiV4AdminZoektNamespacesIdRequest'
  /api/v4/admin/zoekt/shards:
    get:
      operationId: getApiV4AdminZoektShards
      summary: Get all the Zoekt nodes
      description: Returns a list of all Zoekt search nodes available in the instance.
      tags:
      - Code search
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesSearchZoektNode'
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Not found
  /api/v4/admin/zoekt/shards/{node_id}/indexed_namespaces:
    get:
      operationId: getApiV4AdminZoektShardsNodeIdIndexedNamespaces
      summary: Get all the indexed namespaces for this node
      description: Retrieves all root namespaces indexed by the specified Zoekt search node.
      tags:
      - Code search
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesSearchZoektIndexedNamespace'
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Not found
        '400':
          description: Bad Request
      parameters:
      - name: node_id
        required: true
        description: ID of the Zoekt node.
        schema:
          type: integer
        in: path
  /api/v4/admin/zoekt/shards/{node_id}/indexed_namespaces/{namespace_id}:
    put:
      operationId: putApiV4AdminZoektShardsNodeIdIndexedNamespacesNamespaceId
      summary: Add a namespace to a node for Zoekt indexing
      description: Enables and assigns a namespace to a specific Zoekt node for code search indexing.
      tags:
      - Code search
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesSearchZoektIndexedNamespace'
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Not found
        '400':
          description: Bad Request
      parameters:
      - name: node_id
        required: true
        description: ID of the Zoekt node.
        schema:
          type: integer
        in: path
      - name: namespace_id
        required: true
        description: ID of the namespace to index on the node.
        schema:
          type: integer
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4AdminZoektShardsNodeIdIndexedNamespacesNamespaceIdRequest'
    delete:
      operationId: deleteApiV4AdminZoektShardsNodeIdIndexedNamespacesNamespaceId
      summary: Remove a namespace from a node for Zoekt indexing
      description: Removes a namespace from a Zoekt node, deleting its indexed data and disabling search.
      tags:
      - Code search
      responses:
        '204':
          description: No Content
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Not found
        '400':
          description: Bad Request
      parameters:
      - name: node_id
        required: true
        description: ID of the Zoekt node.
        schema:
          type: integer
        in: path
      - name: namespace_id
        required: true
        description: ID of the namespace to remove from the node.
        schema:
          type: integer
        in: path
components:
  schemas:
    APIEntitiesSearchZoektProjectIndexSuccess:
      type: object
      properties:
        job_id:
          type: string
    APIEntitiesSearchZoektNode:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1234
        index_base_url:
          type: string
          example: http://127.0.0.1:6060/
        search_base_url:
          type: string
          example: http://127.0.0.1:6070/
    putApiV4AdminZoektShardsNodeIdIndexedNamespacesNamespaceIdRequest:
      type: object
      properties:
        search:
          type:
          - boolean
          - 'null'
          description: If `true`, enables the indexed namespace for searching.
    patchApiV4AdminZoektNamespacesIdRequest:
      type: object
      properties:
        number_of_replicas_override:
          type:
          - integer
          - 'null'
          minimum: 1
          description: Number of replicas override to set. Set to `null` to unset the override.
    APIEntitiesSearchZoektIndexedNamespace:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1234
        zoekt_shard_id:
          type: integer
          format: int64
          example: 1234
        zoekt_node_id:
          type: integer
          format: int64
          example: 1234
        namespace_id:
          type: integer
          format: int64
          example: 1234
        number_of_replicas_override:
          type: integer
          example: 2
  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