Maven API

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

このAPIを使用して、Mavenパッケージマネージャークライアントと対話します。

このAPIはMavenパッケージマネージャークライアントによって使用され、通常は手動での利用を意図していません。

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

インスタンス用のパッケージファイルをダウンロードする

指定されたMavenパッケージファイルをインスタンス用にダウンロードします。

GET packages/maven/*path/:file_name

属性	型	必須	説明
`path`	文字列	はい	Mavenパッケージのパスは、`<groupId>/<artifactId>/<version>`の形式です。`groupId`内の`.`をすべて`/`に置き換えます。
`file_name`	文字列	はい	Mavenパッケージファイルの名前。

curl --header "PRIVATE-TOKEN: <personal_access_token>" \
  --url "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>" \
  --url "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`	文字列	はい	Mavenパッケージのパスは、`<groupId>/<artifactId>/<version>`の形式です。`groupId`内の`.`をすべて`/`に置き換えます。
`file_name`	文字列	はい	Mavenパッケージファイルの名前。

curl --header "PRIVATE-TOKEN: <personal_access_token>" \
  --url "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>" \
  --url "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`	文字列	はい	Mavenパッケージのパスは、`<groupId>/<artifactId>/<version>`の形式です。`groupId`内の`.`をすべて`/`に置き換えます。
`file_name`	文字列	はい	Mavenパッケージファイルの名前。

curl --header "PRIVATE-TOKEN: <personal_access_token>" \
  --url "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>" \
  --url "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`	文字列	はい	Mavenパッケージのパスは、`<groupId>/<artifactId>/<version>`の形式です。`groupId`内の`.`をすべて`/`に置き換えます。
`file_name`	文字列	はい	Mavenパッケージファイルの名前。

curl --request PUT \
     --upload-file path/to/mypkg-1.0-SNAPSHOT.pom \
     --header "PRIVATE-TOKEN: <personal_access_token>" \
     --url "https://gitlab.example.com/api/v4/projects/1/packages/maven/foo/bar/mypkg/1.0-SNAPSHOT/mypkg-1.0-SNAPSHOT.pom"