GitLab Advanced search rollout API

openapi: 3.2.0
info:
  title: GitLab REST Advanced search rollout 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: Advanced search rollout
  description: 'Use this API to control what percentage of namespaces are indexed for

    advanced search, rolling

    indexing forward or back.'
  x-displayName: Advanced search rollout
paths:
  /api/v4/elasticsearch_indexed_namespaces/rollout:
    put:
      operationId: putApiV4ElasticsearchIndexedNamespacesRollout
      summary: Rollout namespaces to be indexed up to n%
      description: 'This feature was introduced in GitLab 12.7.


        **DEPRECATED**: This endpoint is deprecated and for GitLab.com use only.


        This will only ever increase the number of indexed namespaces. Providing a value lower than the current rolled out percentage will have no effect.


        This percentage is never persisted but is used to calculate the number of new namespaces to rollout.


        If the same percentage is applied again at a later time, due to possible new namespaces being created during the period, some of them will also be indexed. Therefore you may expect that setting this to 10%, then waiting a month and setting to 10% again will trigger new namespaces to be added (i.e. 10% of the number of newly created namespaces in the last month within the given plan).'
      tags:
      - Advanced search rollout
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ElasticsearchIndexedNamespacesRolloutRequest'
  /api/v4/elasticsearch_indexed_namespaces/rollback:
    put:
      operationId: putApiV4ElasticsearchIndexedNamespacesRollback
      summary: Rollback namespaces to be indexed down to n%
      description: 'This feature was introduced in GitLab 12.7.


        **DEPRECATED**: This endpoint is deprecated and for GitLab.com use only.


        This will only ever decrease the number of indexed namespaces. Providing a value higher than the current rolled out percentage will have no effect.


        This percentage is never persisted but is used to calculate the number of namespaces to rollback.'
      tags:
      - Advanced search rollout
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ElasticsearchIndexedNamespacesRollbackRequest'
components:
  schemas:
    putApiV4ElasticsearchIndexedNamespacesRollbackRequest:
      type: object
      properties:
        percentage:
          type: integer
          minimum: 0
          maximum: 100
          description: Percentage of namespaces to enable or disable Elasticsearch indexing for.
        plan:
          type: string
          enum:
          - bronze
          - silver
          - premium
          - gold
          - ultimate
          - ultimate_trial
          - ultimate_trial_paid_customer
          - premium_trial
          - opensource
          description: Subscription tier to rollout Elasticsearch for.
          minLength: 1
      required:
      - percentage
      - plan
    putApiV4ElasticsearchIndexedNamespacesRolloutRequest:
      type: object
      properties:
        percentage:
          type: integer
          minimum: 0
          maximum: 100
          description: Percentage of namespaces to enable or disable Elasticsearch indexing for.
        plan:
          type: string
          enum:
          - bronze
          - silver
          - premium
          - gold
          - ultimate
          - ultimate_trial
          - ultimate_trial_paid_customer
          - premium_trial
          - opensource
          description: Subscription tier to rollout Elasticsearch for.
          minLength: 1
      required:
      - percentage
      - plan
  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