GitLab Batched background migrations API

openapi: 3.2.0
info:
  title: GitLab REST Batched background migrations 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: Batched background migrations
  description: 'Use this API to list, retrieve, pause, and resume the

    batched background migrations running on an instance.


    These endpoints require administrator access to the instance.'
  x-displayName: Batched background migrations
paths:
  /api/v4/admin/batched_background_migrations/{id}:
    get:
      operationId: getApiV4AdminBatchedBackgroundMigrationsId
      summary: Retrieve a batched background migration
      description: Fetches details of a specific batched migration, with optional filtering by database target.
      tags:
      - Batched background migrations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesBatchedBackgroundMigration'
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID of the batched background migration.
        schema:
          type: integer
        in: path
      - name: database
        required: false
        description: Name of the database.
        schema:
          type: string
          enum:
          - main
          - ci
          - sec
          - embedding
          - geo
          default: main
        in: query
  /api/v4/admin/batched_background_migrations:
    get:
      operationId: getApiV4AdminBatchedBackgroundMigrations
      summary: Get the list of batched background migrations
      description: Lists all batched background migrations with optional filters for database and job class name.
      tags:
      - Batched background migrations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesBatchedBackgroundMigration'
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '400':
          description: Bad Request
      parameters:
      - name: database
        required: false
        description: Name of the database.
        schema:
          type: string
          enum:
          - main
          - ci
          - sec
          - embedding
          - geo
          default: main
        in: query
      - name: job_class_name
        required: false
        description: Filter migrations by job class name.
        schema:
          type:
          - string
          - 'null'
        in: query
  /api/v4/admin/batched_background_migrations/{id}/resume:
    put:
      operationId: putApiV4AdminBatchedBackgroundMigrationsIdResume
      summary: Resume a batched background migration
      description: Resumes execution of a previously paused batched background migration.
      tags:
      - Batched background migrations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesBatchedBackgroundMigration'
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Not found
        '422':
          description: You can resume only `paused` batched background migrations.
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID of the batched background migration.
        schema:
          type: integer
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4AdminBatchedBackgroundMigrationsIdResumeRequest'
  /api/v4/admin/batched_background_migrations/{id}/pause:
    put:
      operationId: putApiV4AdminBatchedBackgroundMigrationsIdPause
      summary: Pause a batched background migration
      description: Pauses an active batched background migration temporarily.
      tags:
      - Batched background migrations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesBatchedBackgroundMigration'
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Not found
        '422':
          description: You can pause only `active` batched background migrations.
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID of the batched background migration.
        schema:
          type: integer
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4AdminBatchedBackgroundMigrationsIdPauseRequest'
components:
  schemas:
    APIEntitiesBatchedBackgroundMigration:
      type: object
      properties:
        id:
          type: string
          example: '1234'
        job_class_name:
          type: string
          example: CopyColumnUsingBackgroundMigrationJob
        table_name:
          type: string
          example: events
        column_name:
          type: string
          example: id
        status:
          type: string
          example: active
        progress:
          type: number
          example: 50
        created_at:
          type: string
          format: date-time
          example: '2022-11-28T16:26:39+02:00'
        estimated_time_remaining:
          type: string
          example: 1 day
    putApiV4AdminBatchedBackgroundMigrationsIdPauseRequest:
      type: object
      properties:
        database:
          type: string
          enum:
          - main
          - ci
          - sec
          - embedding
          - geo
          description: Name of the database.
          default: main
    putApiV4AdminBatchedBackgroundMigrationsIdResumeRequest:
      type: object
      properties:
        database:
          type: string
          enum:
          - main
          - ci
          - sec
          - embedding
          - geo
          description: Name of the database.
          default: main
  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