SBOM
This endpoint lets you retrieve the SBOM document of a software project. It supports the following formats:
- CycloneDX version 1.6 in JSON (set
format
tocyclonedx1.6+json
). - CycloneDX version 1.6 in XML (set
format
tocyclonedx1.6+xml
). - CycloneDX version 1.5 in JSON (set
format
tocyclonedx1.5+json
). - CycloneDX version 1.5 in XML (set
format
tocyclonedx1.5+xml
). - CycloneDX version 1.4 in JSON (set
format
tocyclonedx1.4+json
). - CycloneDX version 1.4 in XML (set
format
tocyclonedx1.4+xml
). - SPDX version 2.3 in JSON (set
format
tospdx2.3+json
).
By default it will respond with an empty JSON:API response.
Authorizations
Path parameters
org_idstring · uuidRequired
Unique identifier for an organization
project_idstring · uuidRequired
Unique identifier for a project
Query parameters
versionstringRequiredExample:
Requested API version
2021-06-04
Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
formatstring · enumOptionalExample:
The desired SBOM format of the response.
cyclonedx1.6+json
Possible values: Responses
Headersobject
Show Headers
Responseobject
Show properties
400
Bad Request: A parameter provided as a part of the request was invalid.
application/vnd.api+json
401
Unauthorized: the request requires an authentication token.
application/vnd.api+json
403
Forbidden: the request requires an authentication token with more or different permissions.
application/vnd.api+json
404
Not Found: The resource being operated on could not be found.
application/vnd.api+json
409
Conflict: The requested operation conflicts with the current state of the resource in some way.
application/vnd.api+json
500
Internal Server Error: An error was encountered while attempting to process the request.
application/vnd.api+json
get
Returns the SBOM document of a project
Last updated
Was this helpful?