Skip to content

The release's finding groups, one per CVE

GET
/v1/orgs/{org}/releases/{release}/finding-groups
curl --request GET \
--url 'https://example.com/v1/orgs/example/releases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/finding-groups?include=resolved&limit=50' \
--header 'Authorization: Bearer <token>'

A finding group is one problem: a CVE, or an advisory without a CVE, however many advisories (members) and components it has. Most urgent first: known exploited, then CVSS, then EPSS, then key. Groups resolved by VEX (not_affected, fixed) are left out unless include=resolved. Matching runs in the worker, so a new upload shows its groups shortly after.

The group’s vex_status is the statement on the CVE, else the members’ own statements combined; null means open. statements_differ: a member’s own statement differs from the CVE’s (the CVE’s decides). conflict is null unless another advisory with the CVE names a component a member matched but excludes its version: then it lists, per component, who says affected and who says not affected (with the version that fixes it, when the advisory has one). A conflict never resolves a group.

A page at a time (up to 200 groups, 50 by default): while more is true, ask again with after set to next.

org
required
string

Organization (tenant) slug, e.g. alpenrobotik

release
required
string format: uuid
include
string
Allowed values: resolved

Resolved: also list groups VEX marked not_affected or fixed

limit
integer
default: 50 >= 1 <= 200
after
string

The next of the previous page

A page of finding groups

Media typeapplication/json
object
items
required
Array<object>

One problem in a release: a CVE, or an advisory without a CVE, however many advisories (members) and components bring it in.

object
key
required

The CVE, or “source:id” (e.g. “osv:GO-2024-1”) for an advisory without one

string
ref
required

The group’s finding ref, e.g. Gateway/rev-b@1.4.0:CVE-2024-1234 (GET /v1/orgs/{org}/finding-refs resolves it). Derived from the current product, variant and version names: it changes when one is renamed.

string
cve
required

Null for an advisory without a CVE

string | null
primary
required

The best-ranked member (vendor CSAF, coordinator CSAF, OSV, then NVD); the group’s first member

object
source
required
string
Allowed values: osv nvd csaf
id
required
string
title
required

The NVD record’s title if it is a member, else the first member’s

string
severity

The highest severity across the members (CRITICAL, HIGH, MEDIUM, LOW); absent when none

string
cvss_score
required

Highest CVSS base score across the members

number | null
known_exploited
required

The CVE is in CISA’s KEV catalog, or on ENISA’s exploited list from a source other than CISA

boolean
epss
required

EPSS probability of the CVE (0-1)

number | null
euvd_ids
required

The EUVD IDs of the CVE, sorted; empty when ENISA has none or this installation doesn’t sync the EUVD

Array<string>
vendor_advisories
required

CSAF advisories of vendors and coordinators that name the CVE, as on a vulnerability’s vendor_advisories; empty for a group without a CVE or when no provider this installation syncs has one. A member that is a CSAF record is one of them (its url is the advisory’s page).

Array<object>
object
id
required

Record ID, :, e.g. “siemens:SSA-104023”

string
advisory_id
required

The provider’s advisory ID, e.g. “SSA-104023”

string
provider
required

The provider, e.g. “siemens”, “bsi-wid”, “cisa-ics”

string
provider_name
required

How the provider is shown, e.g. “Siemens ProductCERT”

string
publisher
required

The provider’s category

string
Allowed values: vendor coordinator
title
required
string
url
required

The advisory’s page at the provider, or its CSAF document

string
fixes
required

Products the advisory says are fixed in a version, or have a vendor fix, for the finding’s CVEs (at most 20)

Array<object>
object
product
required
string
fixed_version

The version that fixes the product

string
remediation_url

Where the vendor’s fix is

string
first_seen
required

The earliest member’s first match in this release, never before the SBOM that brings it in

string format: date-time
vex_status
required
One of:
string
Allowed values: not_affected affected fixed under_investigation
statements_differ
required

A member’s own statement differs from the statement on the CVE (the CVE’s decides). Not a conflict.

boolean
members
required

The advisories in the group, in ranking order

Array<object>
object
source
required
string
Allowed values: osv nvd csaf
id
required
string
title
required
string
vex_status
required
One of:
string
Allowed values: not_affected affected fixed under_investigation
matched_via
required

How the member matched the release’s components, sorted (as in Vulnerability)

Array<string>
Allowed values: purl cpe csaf_purl csaf_cpe org_cpe org_csaf
components
required

The component occurrences the members matched

Array<object>
object
sbom_id
required
string format: uuid
ref
required
string
name
required
string
version
string
purl
string
matched_via
required

How the best-ranked member that matched it did

string
Allowed values: purl cpe csaf_purl csaf_cpe org_cpe org_csaf
members
required

IDs of the advisories that matched it

Array<string>
conflict
required
One of:
null
next

The after of the next page; absent on the last. Opaque

string
more
required

More groups follow next

boolean

Example

{
"items": [
{
"primary": {
"source": "osv"
},
"vendor_advisories": [
{
"publisher": "vendor"
}
],
"vex_status": "not_affected",
"members": [
{
"source": "osv",
"vex_status": "not_affected",
"matched_via": [
"purl"
]
}
],
"components": [
{
"matched_via": "purl"
}
],
"conflict": {
"components": [
{
"affected_by": [
{
"source": "osv",
"matched_via": "purl"
}
],
"not_affected_by": [
{
"source": "osv",
"matched_via": "purl"
}
]
}
]
}
}
]
}

Request.invalid (params.field include, limit or after)

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