이 API를 사용하여 원격 미러를 관리합니다. 원격 미러 API를 사용하여 이러한 미러의 상태를 쿼리하고 수정할 수 있습니다.

보안상의 이유로 API 응답의 url 속성에서는 항상 사용자 이름과 비밀번호 정보가 제거됩니다.

프로젝트의 모든 원격 미러 나열#

히스토리

• 속성 host_keys가 GitLab 18.4에서 도입.

지정된 프로젝트의 모든 원격 미러를 나열합니다.

GET /projects/:id/remote_mirrors

지원되는 속성:

성공하면 200 OK와 다음 응답 속성을 반환합니다:

요청 예시:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/42/remote_mirrors"

응답 예시:

[
  {
    "enabled": true,
    "id": 101486,
    "auth_method": "ssh_public_key",
    "last_error": null,
    "last_successful_update_at": "2020-01-06T17:32:02.823Z",
    "last_update_at": "2020-01-06T17:32:02.823Z",
    "last_update_started_at": "2020-01-06T17:31:55.864Z",
    "only_protected_branches": true,
    "keep_divergent_refs": true,
    "update_status": "finished",
    "url": "https://*****:*****@gitlab.com/gitlab-org/security/gitlab.git",
    "host_keys": [
      {
        "fingerprint_sha256": "SHA256:HbW3g8zUjNSksFbqTiUWPWg2Bq1x8xdGUrliXFzSnUw"
      }
    ]
  }
]

프로젝트의 원격 미러 검색#

히스토리

• 속성 host_keys가 GitLab 18.4에서 도입.

프로젝트의 지정된 원격 미러를 검색합니다.

GET /projects/:id/remote_mirrors/:mirror_id

지원되는 속성:

성공하면 200 OK와 다음 응답 속성을 반환합니다:

요청 예시:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/42/remote_mirrors/101486"

응답 예시:

{
  "enabled": true,
  "id": 101486,
  "last_error": null,
  "last_successful_update_at": "2020-01-06T17:32:02.823Z",
  "last_update_at": "2020-01-06T17:32:02.823Z",
  "last_update_started_at": "2020-01-06T17:31:55.864Z",
  "only_protected_branches": true,
  "keep_divergent_refs": true,
  "update_status": "finished",
  "url": "https://*****:*****@gitlab.com/gitlab-org/security/gitlab.git",
  "host_keys": [
    {
      "fingerprint_sha256": "SHA256:HbW3g8zUjNSksFbqTiUWPWg2Bq1x8xdGUrliXFzSnUw"
    }
  ]
}

원격 미러의 공개 키 검색#

히스토리

• GitLab 17.9에서 도입.

SSH 인증을 사용하는 지정된 원격 미러의 공개 키를 검색합니다.

GET /projects/:id/remote_mirrors/:mirror_id/public_key

지원되는 속성:

성공하면 200 OK와 다음 응답 속성을 반환합니다:

요청 예시:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/42/remote_mirrors/101486/public_key"

응답 예시:

{
  "public_key": "ssh-rsa AAAAB3NzaC1yc2EA..."
}

풀 미러 생성#

프로젝트 풀 미러링 API를 사용하여 풀 미러를 구성하는 방법을 알아보세요.

푸시 미러 생성#

히스토리

• GitLab 16.0에서 기본적으로 활성화.
• GitLab 16.2에서 일반 가용성. 기능 플래그 mirror_only_branches_match_regex 제거.
• 필드 auth_method가 GitLab 16.10에서 도입.
• 속성 host_keys가 GitLab 18.4에서 도입.

프로젝트의 푸시 미러를 생성합니다. 푸시 미러링은 기본적으로 비활성화되어 있습니다. 활성화하려면 미러를 생성할 때 선택적 enabled 파라미터를 포함합니다.

POST /projects/:id/remote_mirrors

지원되는 속성:

성공하면 201 Created와 다음 응답 속성을 반환합니다:

요청 예시:

curl --request POST \
  --data "url=https://username:token@example.com/gitlab/example.git" \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/42/remote_mirrors"

응답 예시:

{
    "enabled": false,
    "id": 101486,
    "auth_method": "password",
    "last_error": null,
    "last_successful_update_at": null,
    "last_update_at": null,
    "last_update_started_at": null,
    "only_protected_branches": false,
    "keep_divergent_refs": false,
    "update_status": "none",
    "url": "https://*****:*****@example.com/gitlab/example.git",
    "host_keys": [
      {
        "fingerprint_sha256": "SHA256:HbW3g8zUjNSksFbqTiUWPWg2Bq1x8xdGUrliXFzSnUw"
      }
    ]
}

프로젝트의 원격 미러 업데이트#

히스토리

• 필드 auth_method가 GitLab 16.10에서 도입.
• 속성 host_keys가 GitLab 18.4에서 도입.

지정된 원격 미러의 구성 또는 운영 상태를 업데이트합니다.

PUT /projects/:id/remote_mirrors/:mirror_id

지원되는 속성:

성공하면 200 OK와 다음 응답 속성을 반환합니다:

요청 예시:

curl --request PUT \
  --data "enabled=false" \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/42/remote_mirrors/101486"

응답 예시:

{
    "enabled": false,
    "id": 101486,
    "auth_method": "password",
    "last_error": null,
    "last_successful_update_at": "2020-01-06T17:32:02.823Z",
    "last_update_at": "2020-01-06T17:32:02.823Z",
    "last_update_started_at": "2020-01-06T17:31:55.864Z",
    "only_protected_branches": true,
    "keep_divergent_refs": true,
    "update_status": "finished",
    "url": "https://*****:*****@gitlab.com/gitlab-org/security/gitlab.git",
    "host_keys": [
      {
        "fingerprint_sha256": "SHA256:HbW3g8zUjNSksFbqTiUWPWg2Bq1x8xdGUrliXFzSnUw"
      }
    ]
}

강제 푸시 미러 업데이트#

히스토리

• GitLab 16.11에서 도입.

푸시 미러에 업데이트를 강제 실행합니다.

POST /projects/:id/remote_mirrors/:mirror_id/sync

지원되는 속성:

성공하면 204 No Content를 반환합니다.

요청 예시:

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/42/remote_mirrors/101486/sync"

프로젝트에서 원격 미러 삭제#

프로젝트에서 지정된 원격 미러를 삭제합니다.

DELETE /projects/:id/remote_mirrors/:mirror_id

지원되는 속성:

성공하면 204 No Content를 반환합니다.

요청 예시:

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/42/remote_mirrors/101486"