正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

Maven仮想レジストリAPI

  • プラン: Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated
  • ステータス: ベータ版

このAPIを使用して、以下を行います:

  • Maven仮想レジストリを作成および管理します。
  • アップストリームレジストリを設定します。
  • キャッシュエントリを管理します。
  • パッケージのダウンロードとアップロードを処理します。

仮想レジストリを管理する

Maven仮想レジストリを作成および管理するには、次のエンドポイントを使用します。

すべての仮想レジストリをリストする

グループのすべてのMaven仮想レジストリをリストします。

GET /groups/:id/-/virtual_registries/packages/maven/registries

サポートされている属性:

属性必須説明
id文字列/整数はいグループIDまたはグループのフルパス。トップレベルグループである必要があります。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/groups/5/-/virtual_registries/packages/maven/registries"

レスポンス例:

[
  {
    "id": 1,
    "group_id": 5,
    "name": "my-virtual-registry",
    "description": "My virtual registry",
    "created_at": "2024-05-30T12:28:27.855Z",
    "updated_at": "2024-05-30T12:28:27.855Z"
  }
]

仮想レジストリを作成する

グループのMaven仮想レジストリを作成します。

POST /groups/:id/-/virtual_registries/packages/maven/registries
属性必須説明
id文字列/整数はいグループIDまたはグループのフルパス。トップレベルグループである必要があります。
name文字列はい仮想レジストリの名前。
description文字列いいえ仮想レジストリの説明。

リクエスト例:

curl --request POST \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --header "Accept: application/json" \
     --data '{"name": "my-virtual-registry", "description": "My virtual registry"}' \
     --url "https://gitlab.example.com/api/v4/groups/5/-/virtual_registries/packages/maven/registries"

レスポンス例:

{
  "id": 1,
  "group_id": 5,
  "name": "my-virtual-registry",
  "description": "My virtual registry",
  "created_at": "2024-05-30T12:28:27.855Z",
  "updated_at": "2024-05-30T12:28:27.855Z"
}

仮想レジストリを取得する

特定のMaven仮想レジストリを取得します。

GET /virtual_registries/packages/maven/registries/:id

パラメータは以下のとおりです。

属性必須説明
id整数はいMaven仮想レジストリのID。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/registries/1"

レスポンス例:

{
  "id": 1,
  "group_id": 5,
  "name": "my-virtual-registry",
  "description": "My virtual registry",
  "created_at": "2024-05-30T12:28:27.855Z",
  "updated_at": "2024-05-30T12:28:27.855Z"
}

仮想レジストリを更新する

特定のMaven仮想レジストリを更新します。

PATCH /virtual_registries/packages/maven/registries/:id
属性必須説明
id整数はいMaven仮想レジストリのID。
name文字列はい仮想レジストリの名前。
description文字列いいえ仮想レジストリの説明。

リクエスト例:

curl --request PATCH \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"name": "my-virtual-registry", "description": "My virtual registry"}' \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/registries/1"

成功した場合、200 OKステータスコードを返します。

仮想レジストリを削除する

特定のMaven仮想レジストリを削除します。

DELETE /virtual_registries/packages/maven/registries/:id
属性必須説明
id整数はいMaven仮想レジストリのID。

リクエスト例:

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/registries/1"

成功した場合、204 No Contentステータスコードを返します。

仮想レジストリのキャッシュエントリを削除する

Maven仮想レジストリのすべての排他的なアップストリームレジストリのすべてのキャッシュエントリを削除するようにスケジュールします。キャッシュエントリは、他の仮想レジストリに関連付けられているアップストリームレジストリに対して削除するようにスケジュールされていません。

DELETE /virtual_registries/packages/maven/registries/:id/cache
属性必須説明
id整数はいMaven仮想レジストリのID。

リクエスト例:

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/registries/1/cache"

成功した場合、204 No Contentステータスコードを返します。

アップストリームレジストリを管理する

次のエンドポイントを使用して、アップストリームMavenレジストリを設定および管理します。

トップレベルグループのすべてのアップストリームレジストリをリストする

トップレベルグループのすべてのアップストリームレジストリをリストします。

GET /groups/:id/-/virtual_registries/packages/maven/upstreams

サポートされている属性:

属性必須説明
id文字列/整数はいグループIDまたはグループのフルパス。トップレベルグループである必要があります。
page整数いいえページ番号。デフォルトは1です。
per_page整数いいえページあたりのアイテム数。デフォルトは20です。
upstream_name文字列いいえ名前でファジー検索フィルタリングを行うためのアップストリームレジストリの名前。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/groups/5/-/virtual_registries/packages/maven/upstreams"

レスポンス例:

[
  {
    "id": 1,
    "group_id": 5,
    "url": "https://repo.maven.apache.org/maven2",
    "name": "Maven Central",
    "description": "Maven Central repository",
    "cache_validity_hours": 24,
    "metadata_cache_validity_hours": 24,
    "username": "user",
    "created_at": "2024-05-30T12:28:27.855Z",
    "updated_at": "2024-05-30T12:28:27.855Z"
  }
]

アップストリームレジストリを作成する前に接続をテストする

仮想レジストリに追加されていないMavenアップストリームレジストリへの接続をテストします。このエンドポイントは、アップストリームレジストリを作成する前に、接続と認証情報を検証します。

POST /groups/:id/-/virtual_registries/packages/maven/upstreams/test

サポートされている属性:

属性必須説明
id文字列/整数はいグループIDまたはグループのフルパス。トップレベルグループである必要があります。
url文字列はいアップストリームレジストリのURL。
password文字列いいえアップストリームレジストリのパスワード。
username文字列いいえアップストリームレジストリのユーザー名。

テストワークフロー

testエンドポイントは、接続と認証を検証するために、テストパスを使用して、指定されたアップストリームURLにHEADリクエストを送信します。HEADリクエストから受信したレスポンスは、次のように解釈されます:

アップストリームレスポンス説明結果
2XX成功 - アップストリームアクセス可能{ "success": true }
404成功 - アップストリームはアクセス可能ですが、テストアーティファクトが見つかりません{ "success": true }
401認証に失敗しました{ "success": false, "result": "Error: 401 - Unauthorized" }
403アクセスが禁止されました{ "success": false, "result": "Error: 403 - Forbidden" }
5XXアップストリームサーバーエラー{ "success": false, "result": "Error: 5XX - Server Error" }
ネットワークエラー接続またはタイムアウトの問題{ "success": false, "result": "Error: Connection timeout" }

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --url "https://gitlab.example.com/api/v4/groups/5/-/virtual_registries/packages/maven/upstreams/test" \
     --data '{"url": "https://repo.maven.apache.org/maven2"}'

レスポンス例:

{
  "success": true
}

仮想レジストリのすべてのアップストリームレジストリをリストする

Maven仮想レジストリのすべてのアップストリームレジストリをリストします。

GET /virtual_registries/packages/maven/registries/:id/upstreams

サポートされている属性:

属性必須説明
id整数はいMaven仮想レジストリのID。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/registries/1/upstreams"

レスポンス例:

[
  {
    "id": 1,
    "group_id": 5,
    "url": "https://repo.maven.apache.org/maven2",
    "name": "Maven Central",
    "description": "Maven Central repository",
    "cache_validity_hours": 24,
    "metadata_cache_validity_hours": 24,
    "username": "user",
    "created_at": "2024-05-30T12:28:27.855Z",
    "updated_at": "2024-05-30T12:28:27.855Z",
    "registry_upstream": {
      "id": 1,
      "registry_id": 1,
      "position": 1
    }
  }
]

アップストリームレジストリを作成する

アップストリームレジストリをMaven仮想レジストリに追加します。

POST /virtual_registries/packages/maven/registries/:id/upstreams
属性必須説明
id整数はいMaven仮想レジストリのID。
url文字列はいアップストリームレジストリのURL。
cache_validity_hours整数いいえキャッシュの有効期間。デフォルトは24時間です。
description文字列いいえアップストリームレジストリの説明。
metadata_cache_validity_hours整数いいえメタデータキャッシュの有効期間。デフォルトは24時間です。
name文字列いいえアップストリームレジストリの名前。
password文字列いいえアップストリームレジストリのパスワード。
username文字列いいえアップストリームレジストリのユーザー名。

usernamepasswordの両方をリクエストに含めるか、まったく含めない必要があります。設定されていない場合、パブリック(匿名)リクエストを使用してアップストリームにアクセスします。

同じURLと認証情報(usernamepassword)を持つ2つのアップストリームを同じトップレベルグループに追加することはできません。代わりに、次のいずれかを実行できます。

リクエスト例:

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"url": "https://repo.maven.apache.org/maven2", "name": "Maven Central", "description": "Maven Central repository", "username": <your_username>, "password": <your_password>, "cache_validity_hours": 48, "metadata_cache_validity_hours": 1}' \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/registries/1/upstreams"

レスポンス例:

{
  "id": 1,
  "group_id": 5,
  "url": "https://repo.maven.apache.org/maven2",
  "name": "Maven Central",
  "description": "Maven Central repository",
  "cache_validity_hours": 48,
  "metadata_cache_validity_hours": 1,
  "username": "user",
  "created_at": "2024-05-30T12:28:27.855Z",
  "updated_at": "2024-05-30T12:28:27.855Z",
  "registry_upstream": {
    "id": 1,
    "registry_id": 1,
    "position": 1
  }
}

アップストリームレジストリを取得する

Maven仮想レジストリの特定のアップストリームレジストリを取得します。

GET /virtual_registries/packages/maven/upstreams/:id

パラメータは以下のとおりです。

属性必須説明
id整数はいアップストリームレジストリのID。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/upstreams/1"

レスポンス例:

{
  "id": 1,
  "group_id": 5,
  "url": "https://repo.maven.apache.org/maven2",
  "name": "Maven Central",
  "description": "Maven Central repository",
  "cache_validity_hours": 24,
  "metadata_cache_validity_hours": 24,
  "username": "user",
  "created_at": "2024-05-30T12:28:27.855Z",
  "updated_at": "2024-05-30T12:28:27.855Z",
  "registry_upstreams": [
    {
      "id": 1,
      "registry_id": 1,
      "position": 1
    }
  ]
}

アップストリームレジストリを更新する

Maven仮想レジストリの特定のアップストリームレジストリを更新します。

PATCH /virtual_registries/packages/maven/upstreams/:id
属性必須説明
id整数はいアップストリームレジストリのID。
cache_validity_hours整数いいえキャッシュの有効期間。デフォルトは24時間です。
description文字列いいえアップストリームレジストリの説明。
metadata_cache_validity_hours整数いいえメタデータキャッシュの有効期間。デフォルトは24時間です。
name文字列いいえアップストリームレジストリの名前。
password文字列いいえアップストリームレジストリのパスワード。
url文字列いいえアップストリームレジストリのURL。
username文字列いいえアップストリームレジストリのユーザー名。

usernamepasswordは、一緒に指定するか、まったく指定しないでください。設定されていない場合、パブリック(匿名)リクエストを使用してアップストリームにアクセスします。

リクエスト例:

curl --request PATCH --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"cache_validity_hours": 72}' \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/upstreams/1"

成功した場合、200 OKステータスコードを返します。

アップストリームレジストリの位置を更新する

Maven仮想レジストリの順序付けられたリストで、アップストリームレジストリの位置を更新します。

PATCH /virtual_registries/packages/maven/registry_upstreams/:id
属性必須説明
id整数はいアップストリームレジストリのID。
position整数はいアップストリームレジストリの位置。1~20の間。

リクエスト例:

curl --request PATCH --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"position": 5}' \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/registry_upstreams/1"

成功した場合、200 OKステータスコードを返します。

アップストリームレジストリを削除する

Maven仮想レジストリの特定のアップストリームレジストリを削除します。

DELETE /virtual_registries/packages/maven/upstreams/:id
属性必須説明
id整数はいアップストリームレジストリのID。

リクエスト例:

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/upstreams/1"

成功した場合、204 No Contentステータスコードを返します。

レジストリとアップストリームを関連付ける

既存のアップストリームレジストリをMaven仮想レジストリに関連付けます。

POST /virtual_registries/packages/maven/registry_upstreams
属性必須説明
registry_id整数はいMaven仮想レジストリのID。
upstream_id整数はいMavenアップストリームレジストリのID。

リクエスト例:

curl --request POST \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --header "Accept: application/json" \
     --data '{"registry_id": 1, "upstream_id": 2}' \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/registry_upstreams"

レスポンス例:

{
  "id": 5,
  "registry_id": 1,
  "upstream_id": 2,
  "position": 2
}

レジストリからアップストリームの関連付けを解除する

アップストリームレジストリとMaven仮想レジストリの間の関連付けを削除します。

DELETE /virtual_registries/packages/maven/registry_upstreams/:id
属性必須説明
id整数はいレジストリアップストリームの関連付けのID。

リクエスト例:

curl --request DELETE \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/registry_upstreams/1"

成功した場合、204 No Contentステータスコードを返します。

アップストリームレジストリのキャッシュエントリを削除する

Maven仮想レジストリ内の特定のアップストリームレジストリの削除のためにすべてのキャッシュエントリをスケジュールします。

DELETE /virtual_registries/packages/maven/upstreams/:id/cache
属性必須説明
id整数はいアップストリームレジストリのID。

リクエスト例:

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/upstreams/1/cache"

成功した場合、204 No Contentステータスコードを返します。

アップストリームレジストリへの接続をテストする

既存のMavenアップストリームレジストリへの接続をテストします。

GET /virtual_registries/packages/maven/upstreams/:id/test

テストの仕組み

このエンドポイントは、接続と認証を検証するために、テストパスを使用してアップストリームURLにHEADリクエストを実行します。アップストリームにキャッシュされたアーティファクトがある場合、その相対パスはテストに使用されます。それ以外の場合は、ダミーのパスが使用されます。HEADリクエストから受信したレスポンスは、次のように解釈されます:

アップストリームレスポンス意味結果
2XX成功 - アップストリームアクセス可能{ "success": true }
404成功 - アップストリームはアクセス可能ですが、テストアーティファクトが見つかりません{ "success": true }
401認証に失敗しました{ "success": false, "result": "Error: 401 - Unauthorized" }
403アクセスが禁止されました{ "success": false, "result": "Error: 403 - Forbidden" }
5XXアップストリームサーバーエラー{ "success": false, "result": "Error: 5XX - Server Error" }
ネットワークエラー接続/タイムアウトの問題{ "success": false, "result": "Error: Connection timeout" }

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/upstreams/1/test"

レスポンス例:

{
  "success": true
}

オーバーライドパラメータを使用してアップストリームレジストリへの接続をテストする

オーバーライド可能なパラメータを使用して、既存のMavenアップストリームレジストリへの接続をテストします。

これにより、アップストリームレジストリの設定を更新する前に、URL、ユーザー名、またはパスワードへの変更をテストできます。

POST /virtual_registries/packages/maven/upstreams/:id/test

サポートされている属性:

属性必須説明
id整数はいアップストリームレジストリのID。
password文字列いいえテスト用のオーバーライドパスワード。
url文字列いいえテスト用のオーバーライドURL。指定された場合、アップストリームの設定されたURLの代わりに、このURLへの接続をテストします。
username文字列いいえテスト用のオーバーライドユーザー名。

テストの仕組み

このエンドポイントは、接続と認証を検証するために、テストパスを使用してアップストリームURLにHEADリクエストを実行します。アップストリームにキャッシュされたアーティファクトがある場合、アップストリームの相対パスがテストに使用されます。それ以外の場合は、プレースホルダパスが使用されます。

テストの動作は、指定されたパラメータによって異なります:

  • パラメータなし: アップストリームを現在の設定(既存のURL、ユーザー名、パスワード)でテストします
  • URLオーバーライド: 新しいURLへの接続をテストします。ユーザー名とパスワードは、一緒に指定するか、まったく指定しない必要があります
  • 認証情報オーバーライド: 新しい認証情報で既存のURLをテストします

HEADリクエストから受信したレスポンスは、次のように解釈されます:

アップストリームレスポンス意味結果
2XX成功。アップストリームアクセス可能{ "success": true }
404成功。アップストリームアクセス可能ですが、テストアーティファクトが見つかりません{ "success": true }
401認証に失敗しました{ "success": false, "result": "Error: 401 - Unauthorized" }
403アクセスが禁止されました{ "success": false, "result": "Error: 403 - Forbidden" }
5XXアップストリームサーバーエラー{ "success": false, "result": "Error: 5XX - Server Error" }
ネットワークエラー接続またはタイムアウトの問題{ "success": false, "result": "Error: Connection timeout" }

リクエスト例(既存の設定のテスト):

curl --request POST \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/upstreams/1/test"

リクエスト例(URLオーバーライドがあり、認証情報がないテスト):

curl --request POST \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"url": "<https://new-repo.example.com/maven2>"}' \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/upstreams/1/test"

リクエスト例(URLと認証情報オーバーライドがあるテスト):

curl --request POST \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"url": "<https://new-repo.example.com/maven2>", "username": "<newuser>", "password": "<newpass>"}' \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/upstreams/1/test"

リクエスト例(認証情報オーバーライドがあるテスト):

curl --request POST \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"username": "<newuser>", "password": "<newpass>"}' \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/upstreams/1/test"

レスポンス例:

{
  "success": true
}

キャッシュエントリの管理

Maven仮想レジストリのキャッシュエントリを管理するには、次のエンドポイントを使用します。

アップストリームレジストリキャッシュエントリのリスト

Mavenアップストリームレジストリのキャッシュエントリをリストします。

GET /virtual_registries/packages/maven/upstreams/:id/cache_entries

サポートされている属性:

属性必須説明
id整数はいアップストリームレジストリのID。
page整数いいえページ番号。デフォルトは1です。
per_page整数いいえページあたりのアイテム数。デフォルトは20です。
search文字列いいえパッケージの相対パスの検索クエリ(例:foo/bar/mypkg)。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/upstreams/1/cache_entries?search=foo/bar"

レスポンス例:

[
  {
    "id": "MTUgZm9vL2Jhci9teXBrZy8xLjAtU05BUFNIT1QvbXlwa2ctMS4wLVNOQVBTSE9ULmphcg==",
    "group_id": 5,
    "upstream_id": 1,
    "upstream_checked_at": "2024-05-30T12:28:27.855Z",
    "file_md5": "44f21d5190b5a6df8089f54799628d7e",
    "file_sha1": "74d101856d26f2db17b39bd22d3204021eb0bf7d",
    "size": 2048,
    "relative_path": "foo/bar/package-1.0.0.pom",
    "content_type": "application/xml",
    "upstream_etag": "\"686897696a7c876b7e\"",
    "created_at": "2024-05-30T12:28:27.855Z",
    "updated_at": "2024-05-30T12:28:27.855Z",
    "downloads_count": 6,
    "downloaded_at": "2024-06-05T14:58:32.855Z"
  }
]

アップストリームレジストリキャッシュエントリの削除

Mavenアップストリームレジストリの特定のキャッシュエントリを削除します。

DELETE /virtual_registries/packages/maven/cache_entries/*id
属性必須説明
id文字列はいキャッシュエントリのbase64エンコードされたアップストリームIDと相対パス(例:‘Zm9vL2Jhci9teXBrZy5wb20=’)。

リクエスト例:

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/cache_entries/Zm9vL2Jhci9teXBrZy5wb20="

成功した場合、204 No Contentステータスコードを返します。

パッケージ操作の管理

Maven仮想レジストリのパッケージ操作を管理するには、次のエンドポイントを使用します。

これらのエンドポイントは、REST API認証方式に準拠していません。サポートされているヘッダーとトークンの種類の詳細については、Maven仮想レジストリを参照してください。記載されていない認証方法は、将来削除される可能性があります。

パッケージをダウンロードする

Maven仮想レジストリからパッケージをダウンロードします。このリソースにアクセスするには、レジストリで認証する必要があります。

GET /virtual_registries/packages/maven/:id/*path

サポートされている属性:

属性必須説明
id整数はいMaven仮想レジストリのID。
path文字列はいパッケージのフルパス(例:foo/bar/mypkg/1.0-SNAPSHOT/mypkg-1.0-SNAPSHOT.jar)。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --url "https://gitlab.example.com/api/v4/virtual_registries/packages/maven/1/foo/bar/mypkg/1.0-SNAPSHOT/mypkg-1.0-SNAPSHOT.jar" \
     --output mypkg-1.0-SNAPSHOT.jar

成功した場合、200 OKと、次のレスポンスヘッダーを返します:

  • x-checksum-sha1: ファイルのSHA1チェックサム
  • x-checksum-md5: ファイルのMD5チェックサム
  • Content-Type: ファイルのMIMEタイプ
  • Content-Length: ファイルサイズ(バイト単位)

パッケージのアップロード

Maven仮想レジストリにパッケージをアップロードします。このエンドポイントは、GitLab Workhorseでのみアクセスできます。

POST /virtual_registries/packages/maven/:id/*path/upload
属性必須説明
id整数はいMaven仮想レジストリのID。
fileファイルはいアップロードされるファイル。
path文字列はいパッケージのフルパス(例:foo/bar/mypkg/1.0-SNAPSHOT/mypkg-1.0-SNAPSHOT.jar)。

リクエストヘッダー:

  • Etag: ファイルのエンティティタグ
  • GitLab-Workhorse-Send-Dependency-Content-Type: ファイルコンテンツタイプ
  • Upstream-GID: ターゲットアップストリームのグローバルID

成功した場合、200 OKステータスコードを返します。