Dependency-Track unofficial
GET/v1/bom/cyclonedx/project/{uuid}

Returns dependency metadata for a project in CycloneDX format

Requires permission VIEW_PORTFOLIO

The withVulnerabilities and vdr variants further require any of the following permissions:

  • VIEW_VULNERABILITY
  • VULNERABILITY_ANALYSIS
  • VULNERABILITY_ANALYSIS_READ

5 parameters
uuidstringrequired
The UUID of the project to export
formatstringoptional
The format to output (defaults to JSON)
variantstringoptional
Specifies the CycloneDX variant to export. Value options are 'inventory' and 'withVulnerabilities'. (defaults to 'inventory')
downloadbooleanoptional
Force the resulting BOM to be downloaded as a file (defaults to 'false')
versionstringoptional
The CycloneDX Spec variant exported (defaults to: '1.5')

4 status codes
200Dependency metadata for a project in CycloneDX format
401Unauthorized
403Access to the requested project is forbidden
detailstringrequired
Human-readable explanation specific to this occurrence of the problem
instancestringoptional
Reference URI that identifies the specific occurrence of the problem
statusintegerrequired
HTTP status code generated by the origin server for this occurrence of the problem
titlestringrequired
Short, human-readable summary of the problem type
typestringoptional
A URI reference that identifies the problem type
404The project could not be found

Error handling

A 401 is returned: Unauthorized. A 403 is returned: Access to the requested project is forbidden. A 404 is returned: The project could not be found.