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

Helm API

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

このAPIを使用して、Helmパッケージクライアントとやり取りします。

このAPIは、Helmhelm-pushなどのHelm関連パッケージクライアントで使用され、通常は手動での使用を意図していません。

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

チャートインデックスをダウンロード

チャートのダウンロードURLの一貫性を確保するため、index.yamlの応答のcontextPathフィールドは、プロジェクトIDまたは完全なプロジェクトパスでAPIにアクセスするかどうかにかかわらず、常に数値プロジェクトIDを使用します。

チャートインデックスをダウンロード:

GET projects/:id/packages/helm/:channel/index.yaml
属性必須説明
id文字列はいプロジェクトのIDまたは完全なパス。
channel文字列はいHelmリポジトリチャンネル。
curl --user <username>:<personal_access_token> \
     --url "https://gitlab.example.com/api/v4/projects/1/packages/helm/stable/index.yaml"

出力をファイルに書き込み:

curl --user <username>:<personal_access_token> \
     --url "https://gitlab.example.com/api/v4/projects/1/packages/helm/stable/index.yaml" \
     --remote-name

チャートをダウンロード

チャートをダウンロード:

GET projects/:id/packages/helm/:channel/charts/:file_name.tgz
属性必須説明
id文字列はいプロジェクトのIDまたは完全なパス。
channel文字列はいHelmリポジトリチャンネル。
file_name文字列はいチャートファイル名。
curl --user <username>:<personal_access_token> \
     --url "https://gitlab.example.com/api/v4/projects/1/packages/helm/stable/charts/mychart.tgz" \
     --remote-name

チャートをアップロード

チャートをアップロード:

POST projects/:id/packages/helm/api/:channel/charts
属性必須説明
id文字列はいプロジェクトのIDまたは完全なパス。
channel文字列はいHelmリポジトリチャンネル。
chartファイルはいチャート(multipart/form-dataとして)。
curl --request POST \
     --form 'chart=@mychart.tgz' \
     --user <username>:<personal_access_token> \
     --url "https://gitlab.example.com/api/v4/projects/1/packages/helm/api/stable/charts"