sbom_reports

Creates, updates, deletes, gets or lists a sbom_reports resource.

Overview

Name	sbom_reports
Type	Resource
Id	github.dependency_graph.sbom_reports

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
fetch_sbom_report	exec	owner, repo, sbom_uuid		Fetches a previously generated software bill of materials (SBOM) for a repository. When the SBOM is ready, the response is a 302 redirect to a temporary download URL for the SBOM in SPDX JSON format. The generated SBOM report may be retained for up to one week from the original request. The temporary download URL returned by this endpoint expires separately, and its expiry is set when the fetch request is made.
generate_sbom_report	exec	owner, repo		Triggers a job to generate a software bill of materials (SBOM) for a repository in SPDX JSON format.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
owner	string	The account owner of the repository. The name is not case sensitive.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.
sbom_uuid	string	The unique identifier of the SBOM export.

Lifecycle Methods

fetch_sbom_report

Fetches a previously generated software bill of materials (SBOM) for a repository.
When the SBOM is ready, the response is a 302 redirect to a temporary download URL for the SBOM in SPDX JSON format.
The generated SBOM report may be retained for up to one week from the original request.
The temporary download URL returned by this endpoint expires separately, and its expiry is set when the fetch request is made.

EXEC github.dependency_graph.sbom_reports.fetch_sbom_report 
@owner='{{ owner }}' --required, 
@repo='{{ repo }}' --required, 
@sbom_uuid='{{ sbom_uuid }}' --required
;

generate_sbom_report

Triggers a job to generate a software bill of materials (SBOM) for a repository in SPDX JSON format.

EXEC github.dependency_graph.sbom_reports.generate_sbom_report 
@owner='{{ owner }}' --required, 
@repo='{{ repo }}' --required
;