Sign in

v1

latestOpenAPI 3.0.32026-07-22238629559.2 KB
SupplyChainService

Create a new SBOM export job

post/api/v1/deployments/{deploymentId}/sbom/export

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.

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.

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
refstring

Branch to export SBOM for (Ex. ref=refs/pull/1234/merge).

repositoryIdstring int64

Repository ID to export SBOM for.

sbomOutputFormat'SBOM_OUTPUT_FORMAT_JSON' | 'SBOM_OUTPUT_FORMAT_CYCLONEDX' enum

SBOM output format for the SBOM export.

valuedescription
SBOM_OUTPUT_FORMAT_JSON

Example request

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

Response

OK

taskTokenstring

Task token for the SBOM export job.