GitLab Migrations API

openapi: 3.2.0
info:
  title: GitLab REST 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: Migrations
  description: 'Use this API to mark GitLab database migrations as successful, so that a deployment can proceed

    without re-running them.


    These endpoints are available for GitLab Self-Managed and require administrator access to the instance.'
  x-displayName: Migrations
  externalDocs:
    url: https://docs.gitlab.com/api/database_migrations/
paths:
  /api/v4/admin/migrations/pending:
    get:
      operationId: getApiV4AdminMigrationsPending
      summary: List all pending migrations
      description: Lists all pending migrations for the instance.
      tags:
      - Migrations
      responses:
        '200':
          description: 200 OK
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '400':
          description: Bad Request
      parameters:
      - name: database
        required: false
        description: Database name to query.
        schema:
          type: string
          enum:
          - main
          - ci
          - sec
          - embedding
          - geo
          default: main
        in: query
  /api/v4/admin/migrations/{timestamp}/mark:
    post:
      operationId: postApiV4AdminMigrationsTimestampMark
      summary: Update status of a migration
      description: Updates the status of a migration to indicate a successful execution. This prevent them from being executed by the `db:migrate` tasks. Use this API to skip failing migrations after you determine they are safe to skip.
      tags:
      - Migrations
      responses:
        '201':
          description: 201 Created
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Not found
        '422':
          description: You can mark only pending migrations
        '400':
          description: Bad Request
      parameters:
      - name: timestamp
        required: true
        description: Version timestamp of the migration.
        schema:
          type: integer
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4AdminMigrationsTimestampMarkRequest'
components:
  schemas:
    postApiV4AdminMigrationsTimestampMarkRequest:
      type: object
      properties:
        database:
          type: string
          enum:
          - main
          - ci
          - sec
          - embedding
          - geo
          description: Database name for which the migration is skipped.
          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