GitLab CI/CD

GitLab CI/CD batched_background_migrations API

Operations about batched_background_migrations

GitHub OpenAPI

Operations 4

GET /api/v4/admin/batched_background_migrations/{id} #
PUT /api/v4/admin/batched_background_migrations/{id}/resume #
PUT /api/v4/admin/batched_background_migrations/{id}/pause #
GET /api/v4/admin/batched_background_migrations #

Documentation

📖
Documentation
https://docs.gitlab.com/api/
📖
APIReference
https://docs.gitlab.com/api/api_resources/
📖
Authentication
https://docs.gitlab.com/api/rest/authentication/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gitlab-ci/refs/heads/main/openapi/gitlab-ci-batched-background-migrations-api-openapi.yml

Other Resources

🔗
OpenAPISource
https://docs.gitlab.com/api/openapi/openapi_v2.yaml
🔗
InteractiveDocs
https://docs.gitlab.com/api/openapi/openapi_interactive/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gitlab-ci-batched-background-migrations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gitlab-ci-batched-background-migrations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: GitLab access_requests Batched Background Migrations API
  version: v4
  description: Operations related to access requests
servers:
- url: https://gitlab.com
tags:
- name: batched_background_migrations
  description: Operations about batched_background_migrations
paths:
  /api/v4/admin/batched_background_migrations/{id}:
    get:
      description: Retrieve a batched background migration
      parameters:
      - in: query
        name: database
        description: The name of the database
        required: false
        schema:
          type: string
          enum:
          - main
          - ci
          - sec
          - embedding
          - geo
          default: main
      - in: path
        name: id
        description: The batched background migration id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Retrieve a batched background migration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_BatchedBackgroundMigration'
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Not found
      tags:
      - batched_background_migrations
      operationId: getApiV4AdminBatchedBackgroundMigrationsId
  /api/v4/admin/batched_background_migrations/{id}/resume:
    put:
      description: Resume a batched background migration
      parameters:
      - in: path
        name: id
        description: The batched background migration id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Resume a batched background migration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_BatchedBackgroundMigration'
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Not found
        '422':
          description: You can resume only `paused` batched background migrations.
      tags:
      - batched_background_migrations
      operationId: putApiV4AdminBatchedBackgroundMigrationsIdResume
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4AdminBatchedBackgroundMigrationsIdResume'
        required: true
  /api/v4/admin/batched_background_migrations/{id}/pause:
    put:
      description: Pause a batched background migration
      parameters:
      - in: path
        name: id
        description: The batched background migration id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Pause a batched background migration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_BatchedBackgroundMigration'
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Not found
        '422':
          description: You can pause only `active` batched background migrations.
      tags:
      - batched_background_migrations
      operationId: putApiV4AdminBatchedBackgroundMigrationsIdPause
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4AdminBatchedBackgroundMigrationsIdPause'
        required: true
  /api/v4/admin/batched_background_migrations:
    get:
      description: Get the list of batched background migrations
      parameters:
      - in: query
        name: database
        description: The name of the database, the default `main`
        required: false
        schema:
          type: string
          enum:
          - main
          - ci
          - sec
          - embedding
          - geo
          default: main
      - in: query
        name: job_class_name
        description: Filter migrations by job class name.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Get the list of batched background migrations
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/API_Entities_BatchedBackgroundMigration'
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
      tags:
      - batched_background_migrations
      operationId: getApiV4AdminBatchedBackgroundMigrations
components:
  schemas:
    putApiV4AdminBatchedBackgroundMigrationsIdResume:
      type: object
      properties:
        database:
          type: string
          description: The name of the database
          enum:
          - main
          - ci
          - sec
          - embedding
          - geo
          default: main
      description: Resume a batched background migration
    putApiV4AdminBatchedBackgroundMigrationsIdPause:
      type: object
      properties:
        database:
          type: string
          description: The name of the database
          enum:
          - main
          - ci
          - sec
          - embedding
          - geo
          default: main
      description: Pause a batched background migration
    API_Entities_BatchedBackgroundMigration:
      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
          format: float
          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
      required:
      - id
      - job_class_name
      - table_name
      - column_name
      - status
      - progress
      - created_at
      - estimated_time_remaining
      description: API_Entities_BatchedBackgroundMigration model
  securitySchemes:
    access_token_header:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header
    access_token_query:
      type: apiKey
      name: private_token
      in: query