GitLab Project mirrors API

openapi: 3.2.0
info:
  title: GitLab REST Project mirrors 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: Project mirrors
  description: Use this API to manage project pull mirroring.
  x-displayName: Project mirrors
  externalDocs:
    url: https://docs.gitlab.com/api/project_pull_mirroring/
paths:
  /api/v4/projects/{id}/mirror/pull:
    post:
      operationId: postApiV4ProjectsIdMirrorPull
      summary: Start the pull mirroring process for a project
      description: Starts the pull mirroring process for a specified project.
      tags:
      - Project mirrors
      responses:
        '200':
          description: OK
        '400':
          description: The project is not mirrored
        '403':
          description: Mirroring for the project is on pause
        '422':
          description: The pull request event is not processable
        '404':
          description: Not Found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdMirrorPullRequest'
      x-gitlab-tier: premium
    put:
      operationId: putApiV4ProjectsIdMirrorPull
      summary: Update project pull mirroring settings
      description: Updates pull mirroring settings for a specified project. This feature was introduced in GitLab 17.5.
      tags:
      - Project mirrors
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesPullMirror'
        '400':
          description: 'Url is blocked: Only allowed schemes are http, https, ssh, git'
        '404':
          description: Not Found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdMirrorPullRequest'
      x-gitlab-tier: premium
      x-gitlab-lifecycle: experiment
    get:
      operationId: getApiV4ProjectsIdMirrorPull
      summary: Retrieve project pull mirror details
      description: Retrieves pull mirror details for a specified project.
      tags:
      - Project mirrors
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesPullMirror'
        '400':
          description: The project is not mirrored
        '404':
          description: Not Found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      x-gitlab-tier: premium
components:
  schemas:
    putApiV4ProjectsIdMirrorPullRequest:
      type: object
      properties:
        enabled:
          type:
          - boolean
          - 'null'
          description: If `true`, enables pull mirroring on the project. At least one of `enabled`, `url`, `auth_user`, `auth_password`, `mirror_overwrites_diverged_branches`, `mirror_trigger_builds`, `only_mirror_protected_branches`, `mirror_branch_regex` must be provided.
        url:
          type:
          - string
          - 'null'
          description: URL of the remote repository being mirrored. At least one of `enabled`, `url`, `auth_user`, `auth_password`, `mirror_overwrites_diverged_branches`, `mirror_trigger_builds`, `only_mirror_protected_branches`, `mirror_branch_regex` must be provided.
        auth_user:
          type:
          - string
          - 'null'
          description: Username used to authenticate a project pull mirror. At least one of `enabled`, `url`, `auth_user`, `auth_password`, `mirror_overwrites_diverged_branches`, `mirror_trigger_builds`, `only_mirror_protected_branches`, `mirror_branch_regex` must be provided.
        auth_password:
          type:
          - string
          - 'null'
          description: Password used to authenticate a project pull mirror, or a personal access token with the `api` scope enabled. At least one of `enabled`, `url`, `auth_user`, `auth_password`, `mirror_overwrites_diverged_branches`, `mirror_trigger_builds`, `only_mirror_protected_branches`, `mirror_branch_regex` must be provided.
        mirror_trigger_builds:
          type:
          - boolean
          - 'null'
          description: If `true`, triggers pipelines for mirror updates. At least one of `enabled`, `url`, `auth_user`, `auth_password`, `mirror_overwrites_diverged_branches`, `mirror_trigger_builds`, `only_mirror_protected_branches`, `mirror_branch_regex` must be provided.
        only_mirror_protected_branches:
          type:
          - boolean
          - 'null'
          description: If `true`, limits mirroring to only protected branches. Mutually exclusive with `mirror_branch_regex`. At least one of `enabled`, `url`, `auth_user`, `auth_password`, `mirror_overwrites_diverged_branches`, `mirror_trigger_builds`, `only_mirror_protected_branches`, `mirror_branch_regex` must be provided.
        mirror_overwrites_diverged_branches:
          type:
          - boolean
          - 'null'
          description: If `true`, overwrites diverged branches. At least one of `enabled`, `url`, `auth_user`, `auth_password`, `mirror_overwrites_diverged_branches`, `mirror_trigger_builds`, `only_mirror_protected_branches`, `mirror_branch_regex` must be provided.
        mirror_branch_regex:
          type:
          - string
          - 'null'
          description: Regular expression for branch names to mirror. Only branches with names matching the regex are mirrored. Requires `only_mirror_protected_branches` to be disabled. Mutually exclusive with `only_mirror_protected_branches`. At least one of `enabled`, `url`, `auth_user`, `auth_password`, `mirror_overwrites_diverged_branches`, `mirror_trigger_builds`, `only_mirror_protected_branches`, `mirror_branch_regex` must be provided.
    postApiV4ProjectsIdMirrorPullRequest:
      type: object
      properties:
        action:
          type:
          - string
          - 'null'
          description: Action of the GitHub pull request event.
        pull_request.number:
          type:
          - integer
          - 'null'
          description: Pull request IID
        pull_request.head.ref:
          type:
          - string
          - 'null'
          description: Source branch
        pull_request.head.sha:
          type:
          - string
          - 'null'
          description: Source sha
        pull_request.head.repo.full_name:
          type:
          - string
          - 'null'
          description: Source repository
        pull_request.base.ref:
          type:
          - string
          - 'null'
          description: Target branch
        pull_request.base.sha:
          type:
          - string
          - 'null'
          description: Target sha
        pull_request.base.repo.full_name:
          type:
          - string
          - 'null'
          description: Target repository
        force:
          type:
          - boolean
          - 'null'
          description: If `true`, resets a hard-failed mirror and retries the update. Ignored for requests authenticated with a GitHub webhook signature.
    APIEntitiesPullMirror:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 101486
        update_status:
          type: string
          example: finished
        url:
          type: string
          example: https://*****:*****@gitlab.com/gitlab-org/security/gitlab.git
        last_error:
          type: string
        last_update_at:
          type: string
          format: date-time
          example: '2020-01-06T17:32:02.823Z'
        last_update_started_at:
          type: string
          format: date-time
          example: '2020-01-06T17:32:02.823Z'
        last_successful_update_at:
          type: string
          format: date-time
          example: '2020-01-06T17:32:02.823Z'
        enabled:
          type: boolean
          example: false
        mirror_trigger_builds:
          type: boolean
          example: false
        only_mirror_protected_branches:
          type: boolean
          example: false
        mirror_overwrites_diverged_branches:
          type: boolean
          example: false
        mirror_branch_regex:
          type: string
          example: branch_name
  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