Skip to content

The dependency paths from the root to the components that match a vulnerability

GET
/v1/orgs/{org}/graph/traversals/explain-finding
curl --request GET \
--url https://example.com/v1/orgs/example/graph/traversals/explain-finding \
--header 'Authorization: Bearer <token>'

For a release (its uploaded SBOMs) or a unit (its collector SBOM): up to 3 shortest paths per matching component, at most 32 deep, cycle-safe. Nodes are the components on the paths and the matched vulnerabilities; edges are dependsOn and matches, and excludedBy where another advisory with one of the CVEs excludes a matching component’s version (summary.conflict; the edge has the fixed version). An SBOM without dependency data gives no paths and reason no_dependency_data, never a guessed path; an SBOM listing more than 200,000 dependencies gives no paths, reason dependency_data_too_large and truncated. Another organization’s release or unit answers 404.

org
required
string

Organization (tenant) slug, e.g. alpenrobotik

release
string

A release ID (urn:affectra:release:…); give release or unit

unit
string

A unit ID (urn:affectra:unit:…); give release or unit

vulnerability
string

Any ID we store: a CVE, a GHSA or another OSV ID; required unless finding is given

finding
string

A finding ref (FindingGroup.ref), e.g. Gateway/rev-b@1.4.0:CVE-2024-1234: instead of release and vulnerability

The paths, in summary.paths and as nodes and edges

Media typeapplication/json
object
summary
required

Traversal-specific (Summary); empty for nodes and neighbours.

object
key
additional properties
any
nodes
required
Array<object>
object
id
required

Urn:affectra:… for tenant and shared nodes; public nodes keep their own IDs (CVE-…, CWE-79).

string
class
required
string
Allowed values: Artifact AttackPattern CPEMapping Component EPSSScore EUKEVEntry Finding FindingGroup KEVEntry Organization Product Proposal Release ReleaseAlias SBOM Signature SupportPeriod Technique TrustedPublisher Unit UnitObservation VEXStatement Variant Vulnerability Weakness
label
required

Composed from first-party data only; empty when the ID is the label.

string
properties
required

Only the properties the ontology lists for the class (Properties).

object
key
additional properties
any
edges
required
Array<object>

A relation between two nodes. Agents cite edges as evidence.

object
from
required

Node ID.

string
relation
required
string
Allowed values: about aliasOf assessedBy attestedBy contains dependsOn describedBy enablesPattern excludedBy exploitLikelihood groups hasFinding hasRelease hasSupportPeriod hasVariant hasWeakness issuedBy knownExploited mapsToTechnique matches proposes reported runs subject
to
required

Node ID.

string
properties

The relation’s properties, e.g. MatchesEdgeProperties.

object
key
additional properties
any
truncated
required

A limit cut the result.

boolean
next
required

Opaque cursor for the next page.

string | null
as_of
required

When the data was read.

string format: date-time
feeds
required

The version of each feed the answer used (feed_state), e.g. osv, nvd, kev, epss.

object
key
additional properties
string
feed_status
required

How current each feed is, by feed_state key (osv:Debian, kev, epss, nvd), including feeds with no version yet. Say how old the data is from checked_at; state says whether that is old enough to matter. Times and states only.

object
key
additional properties
object
checked_at
required

The last attempt that succeeded, changed or not; null if the feed has never been checked.

string | null format: date-time
subscribed
required

False when the organization turned this feed off: findings that only it reports are hidden, not deleted (list_feeds names the feeds and who changed them). True for every other feed.

boolean
state
required

From the age of checked_at against the feed’s thresholds (libs/go/feedhealth); never checked is very_stale.

string
Allowed values: ok stale very_stale
summary
required

The dependency paths from an SBOM’s root to the component that matches a vulnerability, for a release (its uploaded SBOMs) or a unit (its collector SBOM). Up to 3 shortest paths per matching component; no guessed path when the SBOM has no dependency data. Also the other side of a source conflict: excludedBy edges from the matching components to advisories that share one of the vulnerability’s CVEs, name the package but exclude the component’s version (with the fixed version when the advisory has one). Give release (or unit) and vulnerability, or a finding ref (finding, e.g. Gateway/rev-b@1.4.0:CVE-2024-1234) that stands for both.

object
resolved
required
Array<string>
conflict
required

The sources disagree: another advisory with one of the CVEs excludes a matching component’s version (an excludedBy edge). Cite that edge and its fixed_version; a conflict never resolves the finding.

boolean
euvd_ids
required

The EUVD IDs of the resolved CVEs (ENISA’s EU Vulnerability Database), sorted; cite them for EU customers and CRA reports.

Array<string>
vendor_advisories
required

CSAF advisories of vendors and coordinators (BSI, CERT@VDE, CISA, Siemens, …) that name the resolved CVEs, by ID; withdrawn ones left out. Point the user to the vendor’s advisory for fixed versions and workarounds.

Array<object>
object
id
required

The record ID, :, e.g. siemens:SSA-104023; a Vulnerability node with the title.

string
provider
required

The provider’s name.

string
publisher
required
string
Allowed values: vendor coordinator
url
required

The advisory’s page, or its CSAF document.

string
matched_via
required

How the components matched; the CPE and mapping ones (cpe, csaf_cpe, org_cpe, org_csaf) are weaker evidence.

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

Up to 3 shortest paths per matching component, shortest first.

Array<object>
object
component
required

The matching sbom-component.

string
nodes
required

Sbom-component IDs from the root (or a component nothing depends on, if the SBOM marks no root or its root depends on nothing) to the matching one.

Array<string>
reason
required

Why paths are missing: no_dependency_data when the SBOMs list no dependencies; dependency_data_too_large when an SBOM lists more than the edges limit (truncated is then true). No path is ever guessed.

string | null
Allowed values: no_dependency_data dependency_data_too_large

Example

{
"nodes": [
{
"class": "Artifact"
}
],
"edges": [
{
"relation": "about"
}
],
"feed_status": {
"additionalProperty": {
"state": "ok"
}
},
"summary": {
"vendor_advisories": [
{
"publisher": "vendor"
}
],
"matched_via": [
"purl"
],
"reason": "no_dependency_data"
}
}

Missing vulnerability, not exactly one of release and unit, finding with release, unit or vulnerability, or finding.refInvalid

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

The server runs without a database (catalog.unavailable), or the query ran past its statement timeout (graph.timeout); try again