Skip to content

The nodes one relation joins a node to, a page at a time

GET
/v1/orgs/{org}/graph/nodes/{id}/neighbours
curl --request GET \
--url 'https://example.com/v1/orgs/example/graph/nodes/example/neighbours?relation=example&direction=out' \
--header 'Authorization: Bearer <token>'

Follows one relation in one direction, 100 neighbours per page; the first node is the one asked about. Edges always point the relation’s way. From a public node (a vulnerability, KEV entry or EPSS score) back to tenant data, only this organization’s nodes are reached.

org
required
string

Organization (tenant) slug, e.g. alpenrobotik

id
required
string

A node ID: urn:affectra::, urn:affectra:sbom-component:: (the ref percent-encoded), or a public ID such as CVE-2024-3094. Percent-encode the whole ID once more for the path segment.

relation
required
string

A relation from the ontology (GraphEdge.relation), e.g. dependsOn, matches, hasFinding

direction
string
default: out
Allowed values: out in

Out (from the relation’s from-class, the default) or in

cursor
string

The next of the previous page

The node and its neighbours; truncated and next when there are more

Media typeapplication/json

The envelope of every graph answer.

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

Example

{
"nodes": [
{
"class": "Artifact"
}
],
"edges": [
{
"relation": "about"
}
],
"feed_status": {
"additionalProperty": {
"state": "ok"
}
}
}

Missing or unknown relation, a relation that doesn’t touch the node’s class, a bad direction or cursor

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