プロジェクトリモートミラーAPI

プラン: Free、Premium、Ultimate
提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

このAPIを使用して、リモートミラーを管理できます。このリモートミラーAPIを使用して、これらのミラーの状態をクエリおよび変更できます。

セキュリティ上の理由から、API応答のurl属性からは、ユーザー名とパスワード情報が常に削除されます。

プロジェクトのすべてのリモートミラーを一覧表示

指定されたプロジェクトのすべてのリモートミラーを一覧表示します。

GET /projects/:id/remote_mirrors

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス。

成功した場合、200 OKと次のレスポンス属性を返します:

属性	型	説明
`auth_method`	文字列	ミラーに使用される認証方法。
`enabled`	ブール値	`true`の場合、ミラーが有効になります。
`host_keys`	配列	リモートミラーのSSHホストキーフィンガープリントの配列。
`id`	整数	リモートミラーのID。
`keep_divergent_refs`	ブール値	`true`の場合、ミラーリング時に分岐したrefsが保持されます。
`last_error`	文字列	最後のミラー試行からのエラーメッセージ。`null`の場合、成功。
`last_successful_update_at`	文字列	最後のミラー更新が正常に完了したタイムスタンプ。ISO 8601形式。
`last_update_at`	文字列	最後のミラー試行のタイムスタンプ。ISO 8601形式。
`last_update_started_at`	文字列	最後のミラー試行が開始されたときのタイムスタンプ。ISO 8601形式。
`only_protected_branches`	ブール値	`true`の場合、保護ブランチのみがミラーされます。
`update_status`	文字列	ミラー更新のステータス。指定可能な値: `none`、`scheduled`、`started`、`finished`、`failed`。
`url`	文字列	セキュリティのために認証情報が削除されたミラーURL。

リクエスト例:

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"
      }
    ]
  }
]

プロジェクトのリモートミラーを取得

指定されたプロジェクトのリモートミラーを取得します。

GET /projects/:id/remote_mirrors/:mirror_id

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス。
`mirror_id`	整数	はい	リモートミラーのID。

成功した場合、200 OKと次のレスポンス属性を返します:

属性	型	説明
`enabled`	ブール値	`true`の場合、ミラーが有効になります。
`id`	整数	リモートミラーのID。
`host_keys`	配列	リモートミラーのSSHホストキーフィンガープリントの配列。
`keep_divergent_refs`	ブール値	`true`の場合、ミラーリング時に分岐したrefsが保持されます。
`last_error`	文字列	最後のミラー試行からのエラーメッセージ。`null`の場合、成功。
`last_successful_update_at`	文字列	最後のミラー更新が正常に完了したタイムスタンプ。ISO 8601形式。
`last_update_at`	文字列	最後のミラー試行のタイムスタンプ。ISO 8601形式。
`last_update_started_at`	文字列	最後のミラー試行が開始されたときのタイムスタンプ。ISO 8601形式。
`only_protected_branches`	ブール値	`true`の場合、保護ブランチのみがミラーされます。
`update_status`	文字列	ミラー更新のステータス。指定可能な値: `none`、`scheduled`、`started`、`finished`、`failed`。
`url`	文字列	セキュリティのために認証情報が削除されたミラーURL。

リクエスト例:

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"
    }
  ]
}

リモートミラーの公開キーを取得

SSH認証を使用する、指定されたリモートミラーの公開キーを取得します。

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

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス。
`mirror_id`	整数	はい	リモートミラーのID。

成功した場合、200 OKと次のレスポンス属性を返します:

属性	型	説明
`public_key`	文字列	リモートミラーの公開キー。

リクエスト例:

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を使用して、プルミラーを設定する方法を学習してください。

プッシュミラーを作成

各プロジェクトには、最大10個の有効なプッシュミラーを設定できます。詳細については、プロジェクトプッシュミラーの最大数を参照してください。

プロジェクトのプッシュミラーを作成します。プッシュミラーリングはデフォルトで無効になっています。有効にするには、ミラーの作成時にオプションパラメータenabledを含めます。

POST /projects/:id/remote_mirrors

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス。
`url`	文字列	はい	リポジトリがミラーリングされるターゲットURL。
`auth_method`	文字列	いいえ	ミラー認証方法。指定可能な値: `ssh_public_key`、`password`。
`enabled`	ブール値	いいえ	`true`の場合、ミラーが有効になります。
`host_keys`	文字列の配列	いいえ	ベア形式(`ssh-ed25519 AAAA...`)または完全な`known_hosts`形式(`hostname ssh-ed25519 AAAA...`)のSSHホストキー。ベアキーは、ミラーURLからホスト名を使用します。
`keep_divergent_refs`	ブール値	いいえ	`true`の場合、ミラーリング時に分岐したrefsが保持されます。
`mirror_branch_regex`	文字列	いいえ	ブランチ名をミラーするための正規表現。正規表現に一致する名前のブランチのみがミラーされます。`only_protected_branches`を無効にする必要があります。PremiumおよびUltimateのみです。
`only_protected_branches`	ブール値	いいえ	`true`の場合、保護ブランチのみがミラーされます。

成功した場合、201 Createdと次のレスポンス属性を返します:

属性	型	説明
`auth_method`	文字列	ミラーに使用される認証方法。
`enabled`	ブール値	`true`の場合、ミラーが有効になります。
`host_keys`	配列	リモートミラーのSSHホストキーフィンガープリントの配列。
`id`	整数	リモートミラーのID。
`keep_divergent_refs`	ブール値	`true`の場合、ミラーリング時に分岐したrefsが保持されます。
`last_error`	文字列	最後のミラー試行からのエラーメッセージ。`null`の場合、成功。
`last_successful_update_at`	文字列	最後のミラー更新が正常に完了したタイムスタンプ。ISO 8601形式。
`last_update_at`	文字列	最後のミラー試行のタイムスタンプ。ISO 8601形式。
`last_update_started_at`	文字列	最後のミラー試行が開始されたときのタイムスタンプ。ISO 8601形式。
`only_protected_branches`	ブール値	`true`の場合、保護ブランチのみがミラーされます。
`update_status`	文字列	ミラー更新のステータス。指定可能な値: `none`、`scheduled`、`started`、`finished`、`failed`。
`url`	文字列	セキュリティのために認証情報が削除されたミラーURL。

リクエスト例:

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"
      }
    ]
}

プロジェクト内のリモートミラーを更新

指定されたリモートミラーの設定または稼働状況を更新します。

PUT /projects/:id/remote_mirrors/:mirror_id

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス。
`mirror_id`	整数	はい	リモートミラーのID。
`auth_method`	文字列	いいえ	ミラー認証方法。指定可能な値: `ssh_public_key`、`password`。
`enabled`	ブール値	いいえ	`true`の場合、ミラーが有効になります。
`host_keys`	文字列の配列	いいえ	ベア形式(`ssh-ed25519 AAAA...`)または完全な`known_hosts`形式(`hostname ssh-ed25519 AAAA...`)のSSHホストキー。ベアキーは、ミラーURLからホスト名を使用します。
`keep_divergent_refs`	ブール値	いいえ	`true`の場合、ミラーリング時に分岐したrefsが保持されます。
`mirror_branch_regex`	文字列	いいえ	ブランチ名をミラーするための正規表現。正規表現に一致する名前のブランチのみがミラーされます。`only_protected_branches`が有効な場合は動作しません。PremiumおよびUltimateのみです。
`only_protected_branches`	ブール値	いいえ	`true`の場合、保護ブランチのみがミラーされます。

成功した場合、200 OKと次のレスポンス属性を返します:

属性	型	説明
`auth_method`	文字列	ミラーに使用される認証方法。
`enabled`	ブール値	`true`の場合、ミラーが有効になります。
`host_keys`	配列	リモートミラーのSSHホストキーフィンガープリントの配列。
`id`	整数	リモートミラーのID。
`keep_divergent_refs`	ブール値	`true`の場合、ミラーリング時に分岐したrefsが保持されます。
`last_error`	文字列	最後のミラー試行からのエラーメッセージ。`null`の場合、成功。
`last_successful_update_at`	文字列	最後のミラー更新が正常に完了したタイムスタンプ。ISO 8601形式。
`last_update_at`	文字列	最後のミラー試行のタイムスタンプ。ISO 8601形式。
`last_update_started_at`	文字列	最後のミラー試行が開始されたときのタイムスタンプ。ISO 8601形式。
`only_protected_branches`	ブール値	`true`の場合、保護ブランチのみがミラーされます。
`update_status`	文字列	ミラー更新のステータス。指定可能な値: `none`、`scheduled`、`started`、`finished`、`failed`。
`url`	文字列	セキュリティのために認証情報が削除されたミラーURL。

リクエスト例:

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"
      }
    ]
}

プッシュミラーの強制プッシュ更新

プッシュミラーへの更新を強制します。

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

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス。
`mirror_id`	整数	はい	リモートミラーのID。

成功した場合、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

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス。
`mirror_id`	整数	はい	リモートミラーの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"