An SBOM with its components and dependency graph
const url = 'https://example.com/v1/orgs/example/sboms/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/v1/orgs/example/sboms/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Organization (tenant) slug, e.g. alpenrobotik
Responses
Section titled “Responses”SBOM
object
E.g. “1.6”, “SPDX-2.3”, “3.0.1”
Tools that wrote the document
Of the raw document
Number of dependency edges
Verified: signed by a run one of the organization’s trusted publishers allows; untrusted: signed, by none of them; unsigned: no signature
A verified Sigstore signature or SBOM attestation, as recorded at upload (append-only evidence)
object
OIDC issuer in the certificate
Certificate identity (the signing workflow’s URI)
Owner/name at signing
Owner/name/.github/workflows/x.yml@ref
Earliest verified timestamp (transparency log or timestamp authority)
Rekor log index
The publisher that allowed the run; absent once deleted
Signature: over the document’s bytes (cosign sign-blob); attestation: an in-toto statement whose predicate is the document (actions/attest-sbom)
Attestations only, e.g. https://cyclonedx.org/bom
Attestations only. The artifacts the SBOM describes, as the attestation names them.
object
E.g. firmware.bin
Digests by algorithm, lowercase hex, e.g. {“sha256”:“…”}
object
Signed from a tag that doesn’t name the release’s version, e.g. refs/tags/v1.0.1 for release 1.0.2. The tag names it when its last segment is the version, with or without a leading v, or ends with it after -, _ or @ (climate-sensor-1.0.2, fw@v1.0.2, climate-sensor/v1.0.2); case is ignored. False when the ref is not a tag (a branch, a pull request). Checked when read, never a reason to refuse an upload.
The trusted publisher that allowed a verified signature, as the organization has it now. Absent when the signature is not verified or the publisher was deleted.
object
Owner/name when the publisher was added
E.g. .github/workflows/release.yml; absent: any workflow
Glob on the ref, e.g. refs/tags/v*; absent: any ref
GitHub environment; absent: any
object
Bom-ref or SPDX id from the document
The component identity; the same for every SBOM that contains the same package
Normalised package URL
Normalised CPE 2.3
The thing the SBOM describes
object
Example
{ "format": "cyclonedx", "signature_status": "verified", "signatures": [ { "status": "verified", "kind": "signature" } ]}No such object in this organization, no such organization, or the caller does not belong to it
Over the operation’s rate-limit budget (x-affectra-budget): code request.rateLimited with params.budget. Wait Retry-After seconds before trying again.
Every error answer, Content-Type
application/problem+json. The web app and integrations translate code; detail is English,
for people reading curl output or CI logs, and may change wording at
any time. Match on code, never on detail.
object
The HTTP status
Stable error codes. A code is never renamed; new ones may be added, so
a client falls back to detail for a code it doesn’t know. Another
organization’s object answers notFound, the same as a missing one.
What went wrong
Values the code’s message needs, e.g. {“field”: “version”}. Only values the caller sent or may see. Empty when the message needs none.
object
Example
{ "code": "notFound"}Headers
Section titled “Headers”Seconds until a request would be allowed again, at least 1