The dependency paths from the root to the components that match a vulnerability
const url = 'https://example.com/v1/orgs/example/graph/traversals/explain-finding';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/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.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Organization (tenant) slug, e.g. alpenrobotik
Query Parameters
Section titled “Query Parameters”A release ID (urn:affectra:release:…); give release or unit
A unit ID (urn:affectra:unit:…); give release or unit
Any ID we store: a CVE, a GHSA or another OSV ID; required unless finding is given
A finding ref (FindingGroup.ref), e.g. Gateway/rev-b@1.4.0:CVE-2024-1234: instead of release and vulnerability
Responses
Section titled “Responses”The paths, in summary.paths and as nodes and edges
object
Traversal-specific (
object
object
Urn:affectra:… for tenant and shared nodes; public nodes keep their own IDs (CVE-…, CWE-79).
Composed from first-party data only; empty when the ID is the label.
Only the properties the ontology lists for the class (
object
A relation between two nodes. Agents cite edges as evidence.
object
Node ID.
Node ID.
The relation’s properties, e.g. MatchesEdgeProperties.
object
A limit cut the result.
Opaque cursor for the next page.
When the data was read.
The version of each feed the answer used (feed_state), e.g. osv, nvd, kev, epss.
object
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
object
The last attempt that succeeded, changed or not; null if the feed has never been checked.
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.
From the age of checked_at against the feed’s thresholds (libs/go/feedhealth); never checked is very_stale.
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
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.
The EUVD IDs of the resolved CVEs (ENISA’s EU Vulnerability Database), sorted; cite them for EU customers and CRA reports.
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.
object
The record ID,
The provider’s name.
The advisory’s page, or its CSAF document.
How the components matched; the CPE and mapping ones (cpe, csaf_cpe, org_cpe, org_csaf) are weaker evidence.
Up to 3 shortest paths per matching component, shortest first.
object
The matching sbom-component.
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.
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.
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.
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
The server runs without a database (catalog.unavailable), or the query ran past its statement timeout (graph.timeout); try again