Skip to main content
POST
Generate a project's SBOM

Authorizations

Authorization
string
header
required

Get access to data with your API token. Example header:

Authorization: Bearer 2991e2fb4b540fe75b8f90677b0b892b6314e4961cb001fe6eb452eee248a628

The token can be provisioned from the Tokens section in your Settings, and requires explicitly enabling Web API access.

Path Parameters

deploymentId
string<int64>
required

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

Example:

123

Body

application/json

This is the API message proto for GenerateSbomAsync, but it should stay roughly in-sync with the product message GenerateSbomRequest.

deploymentId
string<int64>

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

Example:

123

repositoryId
string<int64>

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

Example:

123

ref
string

Branch to export SBOM for.

Example:

"refs/pull/1234/merge"

formatVersion
object
sbomOutputFormat
enum<string>
default:SBOM_OUTPUT_FORMAT_JSON

Output format for the SBOM file.

valuedescription
SBOM_OUTPUT_FORMAT_XML
SBOM_OUTPUT_FORMAT_JSON
Available options:
SBOM_OUTPUT_FORMAT_XML,
SBOM_OUTPUT_FORMAT_JSON
Example:

"SBOM_OUTPUT_FORMAT_JSON"

metadataComponentType
enum<string>

Type of component being documented.

valuedescription
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
Available options:
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
object

Response

202 - application/json

Accepted

taskTokenJwt
string

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