Skip to content

How current the release's vulnerability findings are

GET
/v1/orgs/{org}/releases/{release}/data-freshness
curl --request GET \
--url https://example.com/v1/orgs/example/releases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/data-freshness \
--header 'Authorization: Bearer <token>'

When the worker last matched the release’s components, against which vulnerability feeds and in what state, and how many components can be matched at all. matched_at is the oldest component’s match time: the release is fully checked as of then. Sources are the OSV data sets the components need, nvd when this install syncs it, kev, eukev, euvd when this install syncs it, and epss. States: ok, stale, very_stale (thresholds in). Error texts are not included.

org
required
string

Organization (tenant) slug, e.g. alpenrobotik

release
required
string format: uuid

Data freshness

Media typeapplication/json
object
matched_at
required

Oldest match time among the release’s components; null while none is matched

string | null format: date-time
pending_components
required

Components not matched yet (“matching in progress”)

integer
sources
required
Array<object>
object
feed
required

Eukev: ENISA’s exploited list (EU KEV); euvd: EUVD IDs (ENISA’s EU Vulnerability Database); csaf: a CSAF provider this installation syncs

string
Allowed values: osv nvd kev eukev euvd csaf epss
dataset

OSV data set, e.g. “Debian”, “npm”; the CSAF provider, e.g. “siemens”

string
state
required
string
Allowed values: ok stale very_stale
never_synced

Never checked successfully; the state is very_stale

boolean
checked_at

Last successful check

string format: date-time
changed_at

Last time the data changed

string format: date-time
version

Kev: catalog version; eukev: SHA-256 of the list (it has no version); epss: score date

string
nvd_enabled
required

This install syncs NVD. Without it: no CPE matches and no CVSS scores

boolean
nvd_subscribed
required

False when the organization turned NVD off (PUT …/feeds/nvd): sources leaves it out and NVD’s findings are hidden. Feeds the organization turned off are never in sources.

boolean
coverage
required

The release’s components by how they can be matched; each counted once, in the first that applies

object
components
required
integer
by_purl
required

Package URL with an OSV target

integer
by_cpe
required

No OSV target, but a CPE path: the SBOM’s CPE (private components), the curated list or the organization’s own mapping. Matched against NVD and CSAF advisories

integer
by_csaf
required

Neither, but a CSAF advisory names the package URL: only the CSAF path can match it

integer
not_matchable
required
integer

Example

{
"sources": [
{
"feed": "osv",
"state": "ok"
}
]
}

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.

Media typeapplication/problem+json

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
status
required

The HTTP status

integer
code
required

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.

string
Allowed values: notFound internal request.invalidJson request.invalid request.alreadyExists request.timeInvalid auth.required auth.csrfMissing email.invalid accounts.passwordUnavailable locale.invalid request.rateLimited auth.sessionRequired auth.roleTooLow auth.githubTokenUploadOnly org.suspended org.required request.fieldRequired request.textInvalid request.timeout server.notReady catalog.unavailable report.invalid report.wrongTenant settings.csafNamespaceInvalid settings.digestHourInvalid settings.timeZoneInvalid sbom.invalid sbom.limitExceeded sbom.signatureInvalid sbom.signatureRequired sbom.signatureUnavailable upload.hardwareRevisionRenamed upload.malformed upload.unexpectedPart upload.sbomMissing upload.tooLarge upload.unreadable provenance.invalid provenance.sbomAttestation provenance.signatureRequired provenance.unavailable vex.vulnerabilityInvalid vex.statusInvalid vex.justificationUnknown vex.justificationNotAllowed vex.justificationRequired vex.actionRequired vex.statementTooLong vex.csafNamespaceRequired vex.csafNoStatements release.hasVexStatements finding.refInvalid mapping.purlInvalid mapping.purlVersioned mapping.purlCoveredByOsv mapping.cpeFieldInvalid mapping.builtIn mapping.csafProviderUnknown mapping.csafKindInvalid mapping.csafValueInvalid feeds.notSubscribable accounts.setupEmailLimit member.exists member.joined member.roleInvalid member.ownerGrantDenied member.ownerChangeDenied member.ownerRemoveDenied member.lastOwner github.orgInvalid github.teamInvalid github.roleInvalid github.adminRequired key.nameInvalid key.roleInvalid key.purposeInvalid product.keyInvalid product.keyExists product.keyLocked product.supportEndsInvalid alias.reportedInvalid alias.exists publisher.repositoryInvalid publisher.fieldTooLong publisher.idsIncomplete publisher.repositoryNotFound publisher.githubUnreachable publisher.workflowInvalid publisher.refPatternPrefix publisher.refPatternInvalid publisher.exists graph.vulnerabilityUnknown graph.timeout proposal.evidenceUnknown proposal.evidenceTooLarge proposal.kindInvalid proposal.basisInvalid proposal.notCarryOver proposal.basisMismatch proposal.notPending proposal.sourceSuperseded proposal.ownProposal proposal.fourEyes proposal.personRequired proposal.batchTooLarge proposal.vulnerabilityChanged proposal.reportedChanged proposal.releaseUnknown proposal.evidenceMissing notifications.unavailable notifications.findingsInvalid notifications.tokenInvalid webhook.urlRejected webhook.limitReached webhook.formatUnavailable webhook.headerInvalid webhook.eventTypesInvalid webhook.disabled events.cursorInvalid
detail
required

What went wrong

string
params
required

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
key
additional properties
any

Example

{
"code": "notFound"
}
Retry-After
integer
>= 1

Seconds until a request would be allowed again, at least 1