Maven API

Maven PackagesのAPIドキュメントです。

caution
このAPIはMavenパッケージマネージャークライアントによって使用され、一般的に手動で使用するためのものではありません。

GitLab パッケージレジストリから Maven パッケージをアップロードしてインストールする方法については、Maven パッケージレジストリのドキュメントを参照してください。

note
これらのエンドポイントは標準 API 認証方法に準拠していません。どのヘッダーとトークンタイプがサポートされているかの詳細については、Maven パッケージレジストリのドキュメントを参照してください。文書化されていない認証方法は将来削除される可能性があります。

インスタンスレベルでのパッケージファイルのダウンロード

Maven パッケージファイルをダウンロードします：

GET packages/maven/*path/:file_name
属性種類必須説明
path文字列です。yes <groupId>/<artifactId>/<version> 形式の Maven パッケージパス。groupId の. を/で置き換えます。
file_name文字列です。yesMaven パッケージファイルの名前。
curl --header "Private-Token: <personal_access_token>" "https://gitlab.example.com/api/v4/packages/maven/foo/bar/mypkg/1.0-SNAPSHOT/mypkg-1.0-SNAPSHOT.jar"

ファイルに出力を書き込むには

curl --header "Private-Token: <personal_access_token>" "https://gitlab.example.com/api/v4/packages/maven/foo/bar/mypkg/1.0-SNAPSHOT/mypkg-1.0-SNAPSHOT.jar" >> mypkg-1.0-SNAPSHOT.jar

ダウンロードしたファイルをカレントディレクトリのmypkg-1.0-SNAPSHOT.jar に書き込みます。

グループレベルでのパッケージファイルのダウンロード

Maven パッケージファイルをダウンロードします：

GET groups/:id/-/packages/maven/*path/:file_name
属性種類必須説明
path文字列です。yes <groupId>/<artifactId>/<version> 形式の Maven パッケージパス。groupId の. を/で置き換えます。
file_name文字列です。yesMaven パッケージファイルの名前。
curl --header "Private-Token: <personal_access_token>" "https://gitlab.example.com/api/v4/groups/1/-/packages/maven/foo/bar/mypkg/1.0-SNAPSHOT/mypkg-1.0-SNAPSHOT.jar"

ファイルに出力を書き込むには

curl --header "Private-Token: <personal_access_token>" "https://gitlab.example.com/api/v4/groups/1/-/packages/maven/foo/bar/mypkg/1.0-SNAPSHOT/mypkg-1.0-SNAPSHOT.jar" >> mypkg-1.0-SNAPSHOT.jar

ダウンロードしたファイルをカレントディレクトリのmypkg-1.0-SNAPSHOT.jar に書き込みます。

プロジェクトレベルでのパッケージファイルのダウンロード

Maven パッケージファイルをダウンロードします：

GET projects/:id/packages/maven/*path/:file_name
属性種類必須説明
path文字列です。yes <groupId>/<artifactId>/<version> 形式の Maven パッケージパス。groupId の. を/で置き換えます。
file_name文字列です。yesMaven パッケージファイルの名前。
curl --header "Private-Token: <personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/maven/foo/bar/mypkg/1.0-SNAPSHOT/mypkg-1.0-SNAPSHOT.jar"

ファイルに出力を書き込むには

curl --header "Private-Token: <personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/maven/foo/bar/mypkg/1.0-SNAPSHOT/mypkg-1.0-SNAPSHOT.jar" >> mypkg-1.0-SNAPSHOT.jar

ダウンロードしたファイルをカレントディレクトリのmypkg-1.0-SNAPSHOT.jar に書き込みます。

パッケージファイルのアップロード

Maven パッケージファイルをアップロードします：

PUT projects/:id/packages/maven/*path/:file_name
属性種類必須説明
path文字列です。yes <groupId>/<artifactId>/<version> 形式の Maven パッケージパス。groupId の. を/で置き換えます。
file_name文字列です。yesMaven パッケージファイルの名前。
curl --request PUT \
     --upload-file path/to/mypkg-1.0-SNAPSHOT.pom \
     --header "Private-Token: <personal_access_token>" \
     "https://gitlab.example.com/api/v4/projects/1/packages/maven/foo/bar/mypkg/1.0-SNAPSHOT/mypkg-1.0-SNAPSHOT.pom"