Sign in

v1

latestOpenAPI 3.0.32026-07-22238629559.2 KB
SupplyChainService

Get the status of a SBOM export job

get/api/v1/deployments/{deploymentId}/sbom/export/{taskToken}

Path parameters

deploymentIdstring int64 required

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

taskTokenstring required

Task token for the SBOM export job.

Response

OK

downloadUrlstring

URL to download the SBOM when status is COMPLETED.

errorMessagestring

Error message when status is FAILED.

status'SBOM_EXPORT_STATUS_IN_PROGRESS' | 'SBOM_EXPORT_STATUS_COMPLETED' | 'SBOM_EXPORT_STATUS_FAILED' enum required

Status of the SBOM export job.

valuedescription
SBOM_EXPORT_STATUS_IN_PROGRESSThe SBOM export job is in progress.
SBOM_EXPORT_STATUS_COMPLETEDThe SBOM export job has completed.
SBOM_EXPORT_STATUS_FAILEDThe SBOM export job has failed.