Resolve a finding ref to its release and finding group
const url = 'https://example.com/v1/orgs/example/finding-refs?ref=example';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/finding-refs?ref=example' \ --header 'Authorization: Bearer <token>'A finding ref is the human-readable ID of a finding group: <product>/<variant>@<version>:<key>,
e.g. Gateway/rev-b@1.4.0:CVE-2024-1234, or <product>@<version>:<key> for the default variant.
The key is the group’s key (the CVE, or source:id). Product, variant and version are
percent-encoded (UTF-8) for %, /, @, :, whitespace and control characters only. Every
finding group carries its ref (FindingGroup.ref).
Nothing is stored: a ref is derived from the current names, so after a product or variant is renamed the old ref answers 404. A ref whose product, variant, release or finding group doesn’t exist in the organization answers 404 too; a group resolved by VEX still resolves. ref in the answer is the canonical form.
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”The finding ref, e.g. Gateway/rev-b@1.4.0:CVE-2024-1234
Responses
Section titled “Responses”The finding group the ref names
A finding ref resolved to the release and finding group it names.
object
The ref in canonical form
The variant’s name; default for a ref without one
The finding group’s key: the CVE, or “source:id”
Example generated
{ "ref": "example", "release_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "product_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "variant_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "product": "example", "variant": "example", "version": "example", "key": "example"}Finding.refInvalid (params.reason, English), or request.fieldRequired (params.field ref)
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 or object storage; the catalog is unavailable