依存関係リストエクスポートAPI

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

このAPIを使用して、依存関係リストをエクスポートします。このAPIへのすべての呼び出しには認証が必要です。

依存関係リストのエクスポートを作成する

パイプラインで検出されたすべてのプロジェクト依存関係について、CycloneDX JSONエクスポートを作成します。

認証済みユーザーがread_dependency権限を持っていない場合、このリクエストは403 Forbiddenステータスコードを返します。

SBOMのエクスポートは、エクスポートの作成者のみがアクセスできます。

POST /projects/:id/dependency_list_exports
POST /groups/:id/dependency_list_exports
POST /pipelines/:id/dependency_list_exports

属性	型	必須	説明
`id`	整数	はい	認証済みユーザーがアクセスできるプロジェクト、グループ、またはパイプラインのID。
`export_type`	文字列	はい	エクスポートの形式。受け入れられる値のリストについては、export typesを参照してください。
`send_email`	ブール値	いいえ	`true`に設定すると、エクスポートの完了時に、エクスポートをリクエストしたユーザーにメール通知が送信されます。

curl --request POST \
  --header "PRIVATE-TOKEN: <private_token>" \
  --url "https://gitlab.example.com/api/v4/pipelines/1/dependency_list_exports" \
  --data "export_type=sbom"

作成された依存関係リストエクスポートは、expires_atフィールドで指定された時刻に自動的に削除されます。

レスポンス例:

{
  "id": 2,
  "status": "running",
  "has_finished": false,
  "export_type": "sbom",
  "send_email": false,
  "expires_at": "2025-04-06T09:35:38.746Z",
  "self": "http://gitlab.example.com/api/v4/dependency_list_exports/2",
  "download": "http://gitlab.example.com/api/v4/dependency_list_exports/2/download"
}

エクスポートタイプ

エクスポートは、異なるファイル形式でリクエストできます。一部の形式は特定のオブジェクトでのみ利用可能です。

エクスポートタイプ	説明	利用可能
`dependency_list`	依存関係をキー/バリューペアとしてリストする標準のJSONオブジェクト。	プロジェクト
`sbom`	A CycloneDX 1.4の部品表	パイプライン
`cyclonedx_1_6_json`	A CycloneDX 1.6の部品表	プロジェクト
`json_array`	コンポーネントオブジェクトを含むフラットなJSON配列。	グループ
`csv`	カンマ区切り値（CSV）ドキュメント。	プロジェクト、グループ

単一の依存関係リストエクスポートを取得する

依存関係リストエクスポートを取得します。

GET /dependency_list_exports/:id

属性	型	必須	説明
`id`	整数	はい	依存関係リストエクスポートのID。

curl --request GET \
  --header "PRIVATE-TOKEN: <private_token>" \
  --url "https://gitlab.example.com/api/v4/dependency_list_exports/2"

依存関係リストエクスポートが生成されているときはステータスコードが202 Acceptedで、準備ができたときは200 OKです。

レスポンス例:

{
  "id": 4,
  "has_finished": true,
  "self": "http://gitlab.example.com/api/v4/dependency_list_exports/4",
  "download": "http://gitlab.example.com/api/v4/dependency_list_exports/4/download"
}

依存関係リストエクスポートをダウンロード

単一の依存関係リストエクスポートをダウンロードします。

GET /dependency_list_exports/:id/download

属性	型	必須	説明
`id`	整数	はい	依存関係リストエクスポートのID。

curl --request GET \
  --header "PRIVATE-TOKEN: <private_token>" \
  --url "https://gitlab.example.com/api/v4/dependency_list_exports/2/download"

依存関係リストエクスポートがまだ完了していないか、見つからなかった場合、応答は404 Not Foundです。

レスポンス例:

{
  "bomFormat": "CycloneDX",
  "specVersion": "1.4",
  "serialNumber": "urn:uuid:aec33827-20ae-40d0-ae83-18ee846364d2",
  "version": 1,
  "metadata": {
    "tools": [
      {
        "vendor": "Gitlab",
        "name": "Gemnasium",
        "version": "2.34.0"
      }
    ],
    "authors": [
      {
        "name": "Gitlab",
        "email": "support@gitlab.com"
      }
    ],
    "properties": [
      {
        "name": "gitlab:dependency_scanning:input_file",
        "value": "package-lock.json"
      }
    ]
  },
  "components": [
    {
      "name": "com.fasterxml.jackson.core/jackson-core",
      "purl": "pkg:maven/com.fasterxml.jackson.core/jackson-core@2.9.2",
      "version": "2.9.2",
      "type": "library",
      "licenses": [
        {
          "license": {
            "id": "MIT",
            "url": "https://spdx.org/licenses/MIT.html"
          }
        },
        {
          "license": {
            "id": "BSD-3-Clause",
            "url": "https://spdx.org/licenses/BSD-3-Clause.html"
          }
        }
      ]
    }
  ]
}