Skip to content

Finding IDs

Every finding group has a readable ID, its finding ID. Paste it into a ticket, a chat message or a conversation with your assistant, and everyone in your organization can open the same finding:

Gateway/rev-b@1.4.0:CVE-2024-1234

To copy it, open the release, select Details on the finding and select the copy button next to Finding ID. Copy link copies a link that opens the release with that finding expanded.

A finding ID is the product, the variant, the release’s version and the finding group’s key:

<product>/<variant>@<version>:<key>
  • The key is the CVE, such as CVE-2024-1234. For an advisory without a CVE, it is the source and the advisory’s ID, such as osv:GO-2024-1.
  • For a product without variants, the variant is default, and the ID leaves it out: Gateway@1.4.0:CVE-2024-1234. Writing Gateway/default@1.4.0:CVE-2024-1234 names the same finding.
  • Names keep their case and their characters, including letters with accents and other scripts. Only %, /, @, :, spaces and control characters in the product, variant and version are percent-encoded as UTF-8: the product Edge Gateway with version 1:2.0 is Edge%20Gateway@1%3A2.0:CVE-2024-1234. The key is never encoded.

Affectra stores no finding IDs: it builds them from the current names. If you rename a product or a variant, its findings get new IDs, and the old ones no longer open anything. Deleting the release, or a new SBOM that no longer has the vulnerable component, does the same.

A link to #/finding/ followed by the URL-encoded finding ID opens the release with the finding expanded. Someone in another organization who opens your link sees No such finding, the same as for a finding that does not exist.

To look up a finding ID with the API, call GET /v1/orgs/{org}/finding-refs?ref=<finding ID> with any role. Pass the ID as a URL-encoded query parameter. The answer names the release, its product and variant, and the key:

{
"ref": "Gateway/rev-b@1.4.0:CVE-2024-1234",
"release_id": "0190f0e0-…",
"product_id": "0190f0df-…",
"variant_id": "0190f0e0-…",
"product": "Gateway",
"variant": "rev-b",
"version": "1.4.0",
"key": "CVE-2024-1234"
}

The finding groups of a release (GET /v1/orgs/{org}/releases/{release}/finding-groups) carry their finding ID in ref.

Status When
200 The finding ID names a finding of the release, open or resolved.
400 finding.refInvalid The ID is malformed, for example without @ or the key. params.reason says why.
404 notFound No product, variant, release or finding of your organization has these names: renamed, deleted, or another organization’s.

The agent tools know finding IDs. triage and unassessed_findings list each finding group with its ref, and finding group nodes have it as a property. explain_finding, similar_assessments and propose_vex take a finding ID as finding, in place of release and vulnerability. So you can ask, for example:

Explain Gateway/rev-b@1.4.0:CVE-2024-1234 and propose a statement.