Upload an SBOM document (member; member API keys may upload)
const url = 'https://example.com/v1/orgs/example/releases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/sboms';const options = { method: 'POST', headers: { Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.cyclonedx+json' }, body: '"binary"'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/v1/orgs/example/releases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/sboms \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/vnd.cyclonedx+json' \ --data '"binary"'The body is the raw document; the format is detected: CycloneDX 1.2-1.7 (JSON or XML),
SPDX 2.x (JSON or tag-value), SPDX 3.0 (JSON-LD). At most 16 MiB, 30,000 components (nested
ones included) and 150,000 dependency edges; a document over a limit is refused with 413 (upload.tooLarge
for the size, sbom.limitExceeded for the counts). Text in the document (refs, names, versions, PURLs,
CPEs) must be valid UTF-8 without control characters, at most 255 characters (PURLs and CPEs 1,024);
the whole document is refused with 400 (sbom.invalid, the field named) otherwise. A server handles
a few uploads at once; one that has to wait too long answers 429 with Retry-After
(request.rateLimited). Uploading a document
this release already has changes nothing and answers 200 with the existing SBOM.
Signed SBOMs: send multipart/form-data with the document in part sbom and the
Sigstore bundle from cosign sign-blob --bundle in part sigstore_bundle. The bundle is
verified before anything is created, its GitHub Actions run is matched against the
organization’s trusted publishers, and the result is recorded (signature). Re-uploading a
document with another bundle adds that signature to the existing SBOM.
The bundle may instead be an SBOM attestation (actions/attest-sbom): its predicate must
be the uploaded document (as JSON values), and the artifacts it names are recorded
(signature.subjects).
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Organization (tenant) slug, e.g. alpenrobotik
Request Bodyrequired
Section titled “Request Bodyrequired”Example generated
binaryExample generated
binaryExample generated
binaryobject
The document
Sigstore bundle: a signature over the document (cosign sign-blob –bundle), or an SBOM attestation of it (actions/attest-sbom). At most 64 KiB plus twice the document, and 24 MiB.
Responses
Section titled “Responses”Already uploaded; nothing changed
object
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
False when the release already had this document
Problems that did not stop the upload (invalid PURLs, dependencies on unknown refs, a signer that is not a trusted publisher, a signature for another version’s tag: “signed for tag v1.0.1, not version 1.0.2”, …)
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
Example
{ "sbom": { "format": "cyclonedx", "signature_status": "verified" }, "signature": { "status": "verified", "kind": "signature" }}New SBOM
object
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
False when the release already had this document
Problems that did not stop the upload (invalid PURLs, dependencies on unknown refs, a signer that is not a trusted publisher, a signature for another version’s tag: “signed for tag v1.0.1, not version 1.0.2”, …)
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
Example
{ "sbom": { "format": "cyclonedx", "signature_status": "verified" }, "signature": { "status": "verified", "kind": "signature" }}Not a supported SBOM document (sbom.invalid; a refused text value is named in the reason)
Role below member, or the organization requires a signature by a trusted publisher and the upload has none
No such object in this organization, no such organization, or the caller does not belong to it
Larger than 16 MiB (document, upload.tooLarge) or 24 MiB (bundle), or more than 30,000 components or 150,000 dependencies (sbom.limitExceeded)
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
A bundle was sent and this server cannot verify signatures