v1

latestOpenAPI 3.0.32026-07-22238629559.2 KB

SupplyChain2Service

Generate a project's SBOM

Starts a job to asynchronously generate a Software Bill of Materials (SBOM) for a given project. It does not return the SBOM itself, only schedules the job and returns a task JWT.

The Tasks Service can accept the task token to get the status and result of the job.

post/api/sca/deployments/{deploymentId}/sbom_async

Path parameters

deploymentIdstring int64 required

Deployment ID (numeric). Example: 123. Can be found at /deployments, or in your Settings in the web UI.

Request body

deploymentIdstring int64

Deployment ID (numeric). Example: 123. Can be found at /deployments, or in your Settings in the web UI.

repositoryIdstring int64

Project ID to export SBOM for. Use Projects endpoints to find IDs.

refstring

Branch to export SBOM for.

sbomOutputFormat'SBOM_OUTPUT_FORMAT_XML' | 'SBOM_OUTPUT_FORMAT_JSON' enum

Output format for the SBOM file.

value	description
SBOM_OUTPUT_FORMAT_XML
SBOM_OUTPUT_FORMAT_JSON

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

Type of component being documented.

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

Example request

{
  "ref": "refs/pull/1234/merge",
  "formatVersion": {
    "cyclonedxVersion": "SBOM_CYCLONE_DX_VERSION_V1_7"
  },
  "sbomOutputFormat": "SBOM_OUTPUT_FORMAT_JSON"
}

Response

Accepted

taskTokenJwtstring

Task token to track the status and result of the export job.