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

脆弱性エクスポートAPI

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

このAPIを使用して、脆弱性レポートをエクスポートします。このAPIへのすべての呼び出しには認証が必要です。

プロジェクトレベルの脆弱性エクスポート

プロジェクトの新しい脆弱性エクスポートを作成します。

認証済みユーザーに新しい脆弱性を作成する権限がない場合、このリクエストは403 Forbiddenステータスコードを返します。

各ユーザーは、特定のプロジェクトに対して一度に1つの脆弱性エクスポートのみを作成できます。以前のリクエストがまだ処理中のときにエクスポートをリクエストすると、結果は429 Too Many Requestsエラーになります。

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

POST /security/projects/:id/vulnerability_exports
属性型必須説明
id整数または文字列はい認証済みユーザーがメンバーであるプロジェクトのIDまたはURLエンコードされたパス
send_emailブール値いいえtrueに設定すると、エクスポートが完了したときに、エクスポートをリクエストしたユーザーにメール通知が送信されます。
export_format文字列いいえ値: csv,pdf。デフォルトはcsvです。pdfレポートにはvulnerabilities_pdf_export機能フラグが必要です。
report_dataオブジェクトいいえエクスポートで使用するフロントエンドデータアセットにマップされたレポートコンポーネントのハッシュ。例: { project_vulnerabilities_history: '<svg>some report asset</svg>' }

PDFエクスポートの利用は機能フラグによって制御されます。詳細については、履歴を参照してください。

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/security/projects/1/vulnerability_exports"

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

レスポンス例:

{
  "id": 2,
  "created_at": "2020-03-30T09:35:38.746Z",
  "project_id": 1,
  "group_id": null,
  "format": "csv",
  "status": "created",
  "started_at": null,
  "finished_at": null,
  "send_email": false,
  "expires_at": "2020-04-06T09:35:38.746Z",
  "_links": {
    "self": "https://gitlab.example.com/api/v4/security/vulnerability_exports/2",
    "download": "https://gitlab.example.com/api/v4/security/vulnerability_exports/2/download"
  }
}

グループレベルの脆弱性エクスポート

グループの新しい脆弱性エクスポートを作成します。

認証済みユーザーに新しい脆弱性を作成する権限がない場合、このリクエストは403 Forbiddenステータスコードを返します。

各ユーザーは、特定のグループに対して一度に1つの脆弱性エクスポートのみを作成できます。以前のリクエストがまだ処理中のときにエクスポートをリクエストすると、結果は429 Too Many Requestsエラーになります。

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

POST /security/groups/:id/vulnerability_exports
属性型必須説明
id整数または文字列はい認証済みユーザーがメンバーであるグループのIDまたはURLエンコードされたパス
export_format文字列いいえ値: csv,pdf。デフォルトはcsvです。PDFレポートにはvulnerabilities_pdf_export機能フラグが必要です。
report_dataオブジェクトいいえエクスポートで使用するフロントエンドデータアセットにマップされたレポートコンポーネントのハッシュ。例: { project_vulnerabilities_history: '<svg>some report asset</svg>' }

PDFエクスポートの利用は機能フラグによって制御されます。詳細については、履歴を参照してください。

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/security/groups/1/vulnerability_exports"

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

レスポンス例:

{
  "id": 2,
  "created_at": "2020-03-30T09:35:38.746Z",
  "project_id": null,
  "group_id": 1,
  "format": "csv",
  "status": "created",
  "started_at": null,
  "finished_at": null,
  "expires_at": "2020-04-06T09:35:38.746Z",
  "_links": {
    "self": "https://gitlab.example.com/api/v4/security/vulnerability_exports/2",
    "download": "https://gitlab.example.com/api/v4/security/vulnerability_exports/2/download"
  }
}

インスタンスレベルの脆弱性エクスポート

セキュリティダッシュボードで選択されたユーザーのプロジェクトに対して、新しい脆弱性エクスポートを作成します。

POST /security/vulnerability_exports
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/security/vulnerability_exports"

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

レスポンス例:

{
  "id": 2,
  "created_at": "2020-03-30T09:35:38.746Z",
  "project_id": null,
  "group_id": null,
  "format": "csv",
  "status": "created",
  "started_at": null,
  "finished_at": null,
  "expires_at": "2020-04-06T09:35:38.746Z",
  "_links": {
    "self": "https://gitlab.example.com/api/v4/security/vulnerability_exports/2",
    "download": "https://gitlab.example.com/api/v4/security/vulnerability_exports/2/download"
  }
}

脆弱性エクスポートを取得します

指定された脆弱性エクスポートを取得します。

GET /security/vulnerability_exports/:id
属性型必須説明
id整数または文字列はい脆弱性エクスポートのID
curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/security/vulnerability_exports/2"

脆弱性エクスポートが完了していない場合、応答は202 Acceptedです。

レスポンス例:

{
  "id": 2,
  "created_at": "2020-03-30T09:35:38.746Z",
  "project_id": 1,
  "group_id": null,
  "format": "csv",
  "status": "finished",
  "started_at": "2020-03-30T09:36:54.469Z",
  "finished_at": "2020-03-30T09:36:55.008Z",
  "expires_at": "2020-04-06T09:35:38.746Z",
  "_links": {
    "self": "https://gitlab.example.com/api/v4/security/vulnerability_exports/2",
    "download": "https://gitlab.example.com/api/v4/security/vulnerability_exports/2/download"
  }
}

脆弱性エクスポートをダウンロードします

指定された脆弱性エクスポートをダウンロードします。

GET /security/vulnerability_exports/:id/download
属性型必須説明
id整数または文字列はい脆弱性エクスポートのID
curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/security/vulnerability_exports/2/download"

脆弱性エクスポートがまだ完了していないか、見つからない場合、応答は404 Not Foundです。

レスポンス例:

Group Name,Project Name,Tool,Scanner Name,Status,Vulnerability,Details,Additional Info,Severity,CVE,CWE,Other Identifiers,Detected At,Location,Activity,Comments,Full Path,CVSS Vectors,Dismissal Reason
Gitlab.org,Defend,container_scanning,Trivy,resolved,CVE-2019-14697 in musl-utils-1.1.20-r4,"musl libc through 1.1.23 has an x87 floating-point stack adjustment imbalance, related to the math/i386/ directory. In some cases, use of this library could introduce out-of-bounds writes that are not present in an application's source code.",CVE-2019-14697 in musl-utils-1.1.20-r4,critical,CVE-2019-14697,,"",2022-10-07 13:34:41 UTC,"{""image""=>""python:3.4-alpine"", ""dependency""=>{""package""=>{""name""=>""musl-utils""}, ""version""=>""1.1.20-r4""}, ""operating_system""=>""alpine 3.9.2""}",true,"2022-10-07 13:41:08 UTC|root|resolved|changed vulnerability status to resolved",group/project/1,,,
Gitlab.org,Defend,container_scanning,Trivy,detected,CVE-2019-19242 in sqlite-libs-3.26.0-r3,"SQLite 3.30.1 mishandles pExpr->y.pTab, as demonstrated by the TK_COLUMN case in sqlite3ExprCodeTarget in expr.c.",CVE-2019-19242 in sqlite-libs-3.26.0-r3,medium,CVE-2019-19242,,"",2022-10-07 13:34:41 UTC,"{""image""=>""python:3.4-alpine"", ""dependency""=>{""package""=>{""name""=>""sqlite-libs""}, ""version""=>""3.26.0-r3""}, ""operating_system""=>""alpine 3.9.2""}",true,"",group/project/2,,,
Gitlab.org,Defend,container_scanning,Trivy,detected,CVE-2020-28928 in musl-1.1.20-r4,"In musl libc through 1.2.1, wcsnrtombs mishandles particular combinations of destination buffer size and source character limit, as demonstrated by an invalid write access (buffer overflow).",CVE-2020-28928 in musl-1.1.20-r4,medium,CVE-2020-28928,,"",2022-10-07 13:34:41 UTC,"{""image""=>""python:3.4-alpine"", ""dependency""=>{""package""=>{""name""=>""musl""}, ""version""=>""1.1.20-r4""}, ""operating_system""=>""alpine 3.9.2""}",true,"",group/project/3,,,
Gitlab.org,Defend,dependency_scanning,Gemnasium,detected,Improper Neutralization of Special Elements used in an OS Command ('OS Command Injection') in rack,Carefully crafted requests can cause shell escape sequences to be written to the terminal via Rack's Lint middleware and CommonLogger middleware. These escape sequences can be leveraged to possibly execute commands in the victim's terminal.,Improper Neutralization of Special Elements used in an OS Command ('OS Command Injection') in rack,unknown,Gemfile.lock:rack:gemnasium:60b5a27f-4e4d-4ab4-8ae7-74b4b212e177,,Gemnasium-60b5a27f-4e4d-4ab4-8ae7-74b4b212e177; GHSA-wq4h-7r42-5hrr,2022-10-14 13:16:00 UTC,"{""file""=>""Gemfile.lock"", ""dependency""=>{""package""=>{""name""=>""rack""}, ""version""=>""2.2.3""}}",false,group/project/4,,,
Gitlab.org,Defend,dependency_scanning,Gemnasium,detected,Denial of Service Vulnerability in Rack Multipart Parsing in rack,"Carefully crafted multipart POST requests can cause Rack's multipart parser to take much longer than expected, leading to a possible denial of service vulnerability. Impacted code will use Rack's multipart parser to parse multipart posts.",Denial of Service Vulnerability in Rack Multipart Parsing in rack,unknown,Gemfile.lock:rack:gemnasium:20daa17a-47b5-4f79-80c2-cd8f2db9805c,,Gemnasium-20daa17a-47b5-4f79-80c2-cd8f2db9805c; GHSA-hxqx-xwvh-44m2,2022-10-14 13:16:00 UTC,"{""file""=>""Gemfile.lock"", ""dependency""=>{""package""=>{""name""=>""rack""}, ""version""=>""2.2.3""}}",false,group/project/5,,,
Gitlab.org,Defend,sast,Brakeman,detected,Possible SQL injection,,Possible SQL injection,medium,e52f23a259cd489168b4313317ac94a3f13bffde57b9635171c1a44a9f329e9a,,"""Brakeman Warning Code 0""",2022-10-13 15:16:36 UTC,"{""file""=>""main.rb"", ""class""=>""User"", ""method""=>""index"", ""start_line""=>3}",false,"",group/project/6,,,
Gitlab.org,Defend,sast,Semgrep,dismissed,Improper Neutralization of Special Elements used in an SQL Command ('SQL Injection'),"SQL Injection is a critical vulnerability that can lead to data or system compromise...",,critical,,CWE-89,SCS0002,2023-12-28 10:48:34 UTC,"{""file""=>""WebGoat/App_Code/DB/SqliteDbProvider.cs"", ""start_line""=>274}",false,"2023-12-28 10:51:32 UTC|root|Dismissed|""changed vulnerability status to Dismissed: Not Applicable and the following comment: ""dismiss 5""",gitlab-org/defend/579,,Not applicable,