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

APIを使用した依存関係

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

このエンドポイントへのすべての呼び出しは認証を必要とします。この呼び出しを実行するには、ユーザーはリポジトリを読み取り権限を許可されている必要があります。レスポンスで脆弱性を確認するには、ユーザーはプロジェクトセキュリティダッシュボードの読み取りを許可されている必要があります。

プロジェクト依存関係のリスト

プロジェクト依存関係のリストを取得します。このAPIは、依存関係リスト機能を部分的にミラーリングしています。このリストは、Gemnasiumがサポートする言語とパッケージマネージャーに対してのみ生成できます。

GET /projects/:id/dependencies
GET /projects/:id/dependencies?package_manager=maven
GET /projects/:id/dependencies?package_manager=yarn,bundler
属性必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
package_manager文字列配列いいえ指定されたパッケージマネージャーに属する依存関係を返します。有効な値は、bundlercomposerconangogradlemavennpmnugetpippipenvpnpmyarnsbtsetuptoolsです。
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/4/dependencies"

レスポンス例:

[
  {
    "name": "rails",
    "version": "5.0.1",
    "package_manager": "bundler",
    "dependency_file_path": "Gemfile.lock",
    "vulnerabilities": [
      {
        "name": "DDoS",
        "severity": "unknown",
        "id": 144827,
        "url": "https://gitlab.example.com/group/project/-/security/vulnerabilities/144827"
      }
    ],
    "licenses": [
      {
        "name": "MIT",
        "url": "https://opensource.org/licenses/MIT"
      }
    ]
  },
  {
    "name": "hanami",
    "version": "1.3.1",
    "package_manager": "bundler",
    "dependency_file_path": "Gemfile.lock",
    "vulnerabilities": [],
    "licenses": [
      {
        "name": "MIT",
        "url": "https://opensource.org/licenses/MIT"
      }
    ]
  }
]

依存関係のページネーション

APIの結果はページネーションされるため、デフォルトでは、GETリクエストは一度に20件の結果を返します。

詳細については、ページネーションを参照してください。