The release's images by digest, with the build provenance and SBOM attestations naming each
const url = 'https://example.com/v1/orgs/example/releases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/artifacts';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/releases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/artifacts \ --header 'Authorization: Bearer <token>'One entry per digest an attestation of the release names. warnings never
refuse anything: no_sbom (provenance but no SBOM attestation names it), no_provenance (an
SBOM attestation names it, no provenance does, and the release has provenance for other
images), commit_mismatch (provenance and SBOM attestation come from different commits),
version_mismatch (provenance or an SBOM attestation was signed from a tag that doesn’t name
the release’s version, e.g. v1.0.1 for release 1.0.2).
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Organization (tenant) slug, e.g. alpenrobotik
Responses
Section titled “Responses”Artifacts
One image of a release by digest, with the attestations naming it
object
As an attestation names it, e.g. firmware.bin
E.g. sha256
Lowercase hex
Build provenance naming the digest (without subjects)
Build provenance of a release, as recorded at upload (append-only evidence). The signer fields come from the verified certificate, never from the predicate.
object
Also names the bundle: /v1/orgs/{org}/release-attestations/{id}/bundle
OIDC issuer in the certificate
Certificate identity (the signing workflow’s URI)
Owner/name at signing
The calling workflow: 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
The workflow that ran the build (the certificate’s build signer URI), owner/name/path@ref
Builder_id is not workflow_ref: the build ran in a reusable workflow
The artifacts the run built, as the provenance names them. Left out under ReleaseArtifact.built_by.
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
An SBOM whose attestation names the artifact
object
The SBOM attestation: /v1/orgs/{org}/sboms/{sbom_id}/signatures/{signature_id}/bundle
The signing run’s ref, e.g. refs/tags/v1.0.2
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.
Example
[ { "built_by": [ { "status": "verified" } ], "described_by": [ { "status": "verified" } ], "warnings": [ "no_sbom" ] }]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