Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

API token obtained from the Tokens endpoint. Include as Authorization: Bearer <token>.

Path Parameters

repositoryId
string<uuid>
required

Query Parameters

job_id
string

Scope the view to a specific supply-chain job.

snapshot_id
string

Scope the view to a specific SBOM snapshot.

component_id
string

Return only the given component.

ecosystem
string

Filter by package ecosystem.

status
string

Filter by component status.

relationship
string

Filter by dependency relationship (direct/transitive).

source_file
string

Filter by manifest/lockfile source path.

q
string

Free-text search over component names.

changed
string

Only components changed in this snapshot (true/false).

limit
integer

Page size (default 100).

offset
integer

Page offset (default 0).

Response

Snapshot metadata, a page of components, and paging meta.

The response is of type object.