Get a project's bill of materials

Get the bill of materials for the latest alignment or, optionally, a specific alignment for the project based on the revision or alignment id.

To request an bill of materials, both a file format and SBOM type must be specified.

The file format can be specified in several ways:

• using the format query parameter
• using the Accept header
• using a file extension on the route (e.g. sbom.json to request the JSON file format).

The SBOM type can be specified using the sbom_type query parameter.

Supported combinations:

• format=json, sbom_type=tidelift: generic Tidelift JSON bill of materials
  • This format will also be used if both format and sbom_type are omitted
• format=json, sbom_type=cyclonedx
• format=csv, sbom_type=tidelift: generic Tidelift CSV bill of materials
  • This format will also be used if sbom_type is omitted
• format=xml, sbom_type=cyclonedx
• format=spdx, sbom_type=spdx
  • for SPDX, only specifying format is necessary, sbom_type can be inferred

Older versions of the API supported using only the format query parameter (without also specifying an sbom_type). The following mappings are provided to maintain backwards compatibility.

• format=cyclonedx or format=cyclone_dx implies format=xml and sbom_type=cyclonedx.
• format=spdx also implies sbom_type=spdx