Skip to main content
POST
Get SBOM Results

Body

application/json
repo
string
required

Repository identifier (format varies by service)

Example:

"owner/repository"

access_token
string
required

Authentication token for the service

Example:

"ghp_xxxxxxxxxxxx"

service
enum<string>
required

Version control service provider

Available options:
github,
azuredevops,
gitlab,
bitbucket
Example:

"github"

commit_id
string

Git commit SHA or identifier. Either commit_id or branch is required. If both are provided, commit_id takes precedence.

Example:

"abc123def456"

branch
string

Git branch name. When provided without commit_id, the service resolves the latest commit from scan history for this branch. Either commit_id or branch is required.

Example:

"main"

gitlab_base_url
string

Base URL for the service (optional for GitHub, required for GitLab)

Example:

"https://gitlab.com"

Response

SBOM results retrieved successfully

Software Bill of Materials (SBOM) response containing package and license information

results
object

SBOM analysis results

status
enum<string>

Status of the SBOM analysis

Available options:
pending,
processing,
done,
failed
Example:

"done"

commit_id
string

Git commit SHA that was analyzed

Example:

"abc123def456"