7.6. API を使用してミラー組織を作成する

手順

1. POST/api/v1/organization/{orgname}/mirror エンドポイントを使用して、組織レベルの新しいミラーリング設定を作成します。

   $ curl -X POST "https://<quay-server.example.com>/api/v1/organization/<orgname>/mirror" \
     -H "Authorization: Bearer <access_token>" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     -d '{
       "external_registry_type": "quay",
       "external_registry_url": "https://quay.io",
       "external_namespace": "<external_namespace>",
       "robot_username": "<orgname>+<robot_account>",
       "visibility": "private",
       "sync_interval": 3600,
       "sync_start_date": "2025-01-01T00:00:00Z",
       "is_enabled": true
     }'

2. 組織レベルのミラーリング設定を取得するには、GET/api/v1/organization/{orgname}/mirror エンドポイントを使用します。

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     https://<quay-server.example.com>/api/v1/organization/<orgname>/mirror

   出力例

   {"is_enabled": true, "external_registry_type": "quay", "external_registry_url": "http://quay.io", "external_namespace": "test", "external_registry_username": null, "external_registry_config": {}, "repository_filters": [], "robot_username": "example+test", "visibility": "private", "sync_interval": 3600, "sync_start_date": "2025-01-01T00:00:00Z", "sync_expiration_date": null, "sync_status": "NEVER_RUN", "sync_retries_remaining": 3, "skopeo_timeout": 300, "creation_date": "2026-03-09T18:39:21.993431Z"}

3. 組織内でミラーリングされているリポジトリーのリストを取得するには、GET/api/v1/organization/{orgname}/mirror/repositories エンドポイントを使用します。

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     "https://<quay-server.example.com>/api/v1/organization/<orgname>/mirror/repositories?page=1&limit=100"

   出力例

   {"repositories": [], "page": 1, "limit": 100, "total": 0, "has_next": false}

4. 組織内のすべてのリポジトリーの即時同期をトリガーするには 、POST/api/v1/organization/{orgname}/mirror/sync-now エンドポイントを使用します。

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     https://<quay-server.example.com>/api/v1/organization/<orgname>/mirror/sync-now

   このコマンドは CLI に出力を返しません。

5. 組織内のすべてのリポジトリーの保留中の同期をキャンセルするには、POST/api/v1/organization/{orgname}/mirror/sync-cancel エンドポイントを使用します。

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     https://<quay-server.example.com>/api/v1/organization/<orgname>/mirror/sync-cancel

   このコマンドは CLI に出力を返しません。

6. 組織レベルのミラーリング設定を更新するには、PUT/api/v1/organization/{orgname}/mirror エンドポイントを使用します。

   $ curl -X PUT \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     -d '{"is_enabled": true, "sync_interval": 7200}' \
     https://<quay-server.example.com>/api/v1/organization/<orgname>/mirror

   出力例

   " "

7. 組織レベルのミラーリング設定における外部レジストリーへの接続を確認するには、POST/api/v1/organization/{orgname}/mirror/verify エンドポイントを使用します。

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     https://<quay-server.example.com>/api/v1/organization/<orgname>/mirror/verify

   出力例

   {"success": false, "message": "Unexpected response: 301"}

8. 組織レベルのミラーリング設定を削除するには、DELETE/api/v1/organization/{orgname}/mirror エンドポイントを使用します。

   $ curl -X DELETE \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     https://<quay-server.example.com>/api/v1/organization/<orgname>/mirror

   このコマンドは CLI に出力を返しません。