---
title: "Create a new SBOM export job"
method: POST
path: "/api/v1/deployments/{deploymentId}/sbom/export"
tags: ["SupplyChainService"]
---

# Create a new SBOM export job

`POST /api/v1/deployments/{deploymentId}/sbom/export`

## Path parameters

- `deploymentId` string, int64, required — Deployment ID (numeric). Example: `123`. Can be found at `/deployments`, or in your Settings in the web UI.

## Request body

- ProtosOpenapiV1CreateSbomExportRequest
  - `deploymentId` string, int64 — Deployment ID (numeric). Example: `123`. Can be found at `/deployments`, or in your Settings in the web UI.
  - `formatVersion` ProtosScaV1SbomFormatVersion
    - `format` 'SBOM_FORMAT_CYCLONEDX', enum — Format for the SBOM export. | value | description | |-------|---------------| | SBOM_FORMAT_CYCLONEDX | |
    - `cyclonedxVersion` 'SBOM_CYCLONE_DX_VERSION_V1_4' | 'SBOM_CYCLONE_DX_VERSION_V1_5' | 'SBOM_CYCLONE_DX_VERSION_V1_6' | 'SBOM_CYCLONE_DX_VERSION_V1_7', enum — CycloneDX schema version for the SBOM export. Supported: 1.4, 1.5, 1.6, 1.7. Defaults to 1.4 when unset. | value | description | |-------|---------------| | SBOM_CYCLONE_DX_VERSION_V1_4 | | | SBOM_CYCLONE_DX_VERSION_V1_5 | | | SBOM_CYCLONE_DX_VERSION_V1_6 | | | SBOM_CYCLONE_DX_VERSION_V1_7 | |
  - `metadataComponentType` 'SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_APPLICATION' | 'SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_FRAMEWORK' | 'SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_LIBRARY' | 'SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_CONTAINER' | 'SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_PLATFORM' | 'SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_OPERATING_SYSTEM' | 'SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_DEVICE' | 'SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_DEVICE_DRIVER' | 'SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_FIRMWARE' | 'SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_FILE' | 'SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_MACHINE_LEARNING_MODEL' | 'SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_DATA', enum — Metadata component type for the SBOM export. | value | description | |-------|---------------| | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_APPLICATION | | | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_FRAMEWORK | | | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_LIBRARY | | | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_CONTAINER | | | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_PLATFORM | | | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_OPERATING_SYSTEM | | | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_DEVICE | | | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_DEVICE_DRIVER | | | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_FIRMWARE | | | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_FILE | | | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_MACHINE_LEARNING_MODEL | | | SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_DATA | |
  - `metadataSupplier` ProtosScaV1SbomMetadataSupplier
    - `name` string
    - `url` string
    - `contact` ProtosScaV1SbomMetadataContact
      - `name` string
      - `email` string
      - `phone` string
  - `ref` string — Branch to export SBOM for (Ex. ref=`refs/pull/1234/merge`).
  - `repositoryId` string, int64 — Repository ID to export SBOM for.
  - `sbomOutputFormat` 'SBOM_OUTPUT_FORMAT_JSON' | 'SBOM_OUTPUT_FORMAT_CYCLONEDX', enum — SBOM output format for the SBOM export. | value | description | |-------|---------------| | SBOM_OUTPUT_FORMAT_JSON | |

## Response `200`

OK

- ProtosOpenapiV1CreateSbomExportResponse
  - `taskToken` string — Task token for the SBOM export job.

---

[API](https://skmtc.net/semgrep/apis/semgrep-web-app.md) · [All operations](https://skmtc.net/semgrep/apis/semgrep-web-app/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/semgrep/semgrep-web-app/revisions/6483eeecd582/schema)