GitLab Remote mirrors API

openapi: 3.2.0
info:
  title: GitLab REST Remote 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: Remote mirrors
  description: 'Use this API to manage remote mirrors.

    You can query and modify the state of these mirrors.


    For security reasons, the `url` attribute in the API response is always scrubbed of username

    and password information.


    > [!note]

    > Pull mirrors use

    > a different API endpoint to

    > display and update them.'
  x-displayName: Remote mirrors
  externalDocs:
    url: https://docs.gitlab.com/api/remote_mirrors/
paths:
  /api/v4/projects/{id}/remote_mirrors:
    get:
      operationId: getApiV4ProjectsIdRemoteMirrors
      summary: List all remote mirrors for a project
      description: Lists all remote mirrors for a specified project.
      tags:
      - Remote mirrors
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesRemoteMirror'
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
    post:
      operationId: postApiV4ProjectsIdRemoteMirrors
      summary: Create a push mirror
      description: Creates a push mirror.
      tags:
      - Remote mirrors
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesRemoteMirror'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '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: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdRemoteMirrorsRequest'
  /api/v4/projects/{id}/remote_mirrors/{mirror_id}:
    get:
      operationId: getApiV4ProjectsIdRemoteMirrorsMirrorId
      summary: Retrieve a remote mirror for a project
      description: Retrieves a specified remote mirror for a project.
      tags:
      - Remote mirrors
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesRemoteMirror'
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: mirror_id
        required: true
        description: ID of the remote mirror.
        schema:
          type: string
        in: path
    put:
      operationId: putApiV4ProjectsIdRemoteMirrorsMirrorId
      summary: Update a remote mirror in a project
      description: Updates the configuration or operational status of a specified remote mirror.
      tags:
      - Remote mirrors
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesRemoteMirror'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '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
      - name: mirror_id
        required: true
        description: ID of the remote mirror.
        schema:
          type: string
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdRemoteMirrorsMirrorIdRequest'
    delete:
      operationId: deleteApiV4ProjectsIdRemoteMirrorsMirrorId
      summary: Delete a remote mirror from a project
      description: Deletes a specified remote mirror from a project.
      tags:
      - Remote mirrors
      responses:
        '204':
          description: No Content
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '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
      - name: mirror_id
        required: true
        description: ID of the remote mirror.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/remote_mirrors/{mirror_id}/sync:
    post:
      operationId: postApiV4ProjectsIdRemoteMirrorsMirrorIdSync
      summary: Force push mirror update
      description: Forces an update to a push mirror.
      tags:
      - Remote mirrors
      responses:
        '204':
          description: No Content
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '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
      - name: mirror_id
        required: true
        description: ID of the remote mirror.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/remote_mirrors/{mirror_id}/public_key:
    get:
      operationId: getApiV4ProjectsIdRemoteMirrorsMirrorIdPublicKey
      summary: Retrieve a public key for a remote mirror
      description: Retrieves the public key of a specified remote mirror that uses SSH authentication.
      tags:
      - Remote mirrors
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: mirror_id
        required: true
        description: ID of the remote mirror.
        schema:
          type: string
        in: path
components:
  schemas:
    APIEntitiesMirrorHostKey:
      type: object
      properties:
        fingerprint_sha256:
          type: string
          example: SHA256:abcd1234
    putApiV4ProjectsIdRemoteMirrorsMirrorIdRequest:
      type: object
      properties:
        enabled:
          type:
          - boolean
          - 'null'
          description: If `true`, the mirror is enabled.
          example: true
        auth_method:
          type:
          - string
          - 'null'
          description: Mirror authentication method.
        keep_divergent_refs:
          type:
          - boolean
          - 'null'
          description: If `true`, divergent refs are kept when mirroring.
        only_protected_branches:
          type:
          - boolean
          - 'null'
          description: If `true`, only protected branches are mirrored. Mutually exclusive with `mirror_branch_regex`.
        mirror_branch_regex:
          type:
          - string
          - 'null'
          description: Determines if only matched branches are mirrored. Mutually exclusive with `only_protected_branches`.
        host_keys:
          type:
          - array
          - 'null'
          items:
            type: string
          description: SSH host keys in bare format, such as `ssh-ed25519 AAAA...`, or full `known_hosts` format, such as `hostname ssh-ed25519 AAAA...`. Bare keys use the hostname from the mirror URL.
    APIEntitiesRemoteMirror:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 101486
        enabled:
          type: boolean
          example: true
        url:
          type: string
          example: https://*****:*****@example.com/gitlab/example.git
        update_status:
          type: string
          example: finished
        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:31:55.864Z'
        last_error:
          type: string
          example: The remote mirror URL is invalid.
        only_protected_branches:
          type: boolean
        keep_divergent_refs:
          type: boolean
        auth_method:
          type: string
          example: password
        host_keys:
          type: array
          items:
            $ref: '#/components/schemas/APIEntitiesMirrorHostKey'
        mirror_branch_regex:
          type: string
          example: feature-.*
    postApiV4ProjectsIdRemoteMirrorsRequest:
      type: object
      properties:
        url:
          type:
          - string
          - 'null'
          description: Target URL to which the repository is mirrored.
          example: https://*****:*****@example.com/gitlab/example.git
        enabled:
          type:
          - boolean
          - 'null'
          description: If `true`, the mirror is enabled.
        auth_method:
          type:
          - string
          - 'null'
          enum:
          - ssh_public_key
          - password
          - null
          description: Mirror authentication method.
        keep_divergent_refs:
          type:
          - boolean
          - 'null'
          description: If `true`, divergent refs are kept when mirroring.
        only_protected_branches:
          type:
          - boolean
          - 'null'
          description: If `true`, only protected branches are mirrored. Mutually exclusive with `mirror_branch_regex`.
        mirror_branch_regex:
          type:
          - string
          - 'null'
          description: Determines if only matched branches are mirrored. Mutually exclusive with `only_protected_branches`.
        host_keys:
          type:
          - array
          - 'null'
          items:
            type: string
          description: SSH host keys in bare format, such as `ssh-ed25519 AAAA...`, or full `known_hosts` format, such as `hostname ssh-ed25519 AAAA...`. Bare keys use the hostname from the mirror URL.
      required:
      - url
  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