이 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

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"
}

내보내기 형식#

내보내기는 여러 파일 형식으로 요청할 수 있습니다. 일부 형식은 특정 객체에서만 사용할 수 있습니다.

단일 의존성 목록 내보내기 조회#

의존성 목록 내보내기를 조회합니다.

GET /dependency_list_exports/: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

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

의존성 목록 내보내기가 아직 완료되지 않았거나 찾을 수 없으면 응답은 404 Not Found 입니다.

CycloneDX 내보내기에서 SPDX 라이선스 표현식(예: MIT AND Zlib)을 가진 컴포넌트는 licenses[].license.name에 전체 표현식이 들어가며, 해당 항목에는 id 필드가 없습니다.

응답 예시:

{
  "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"
          }
        }
      ]
    }
  ]
}