The CSAF 2.0 csaf_vex advisory for one vulnerability across the organization's releases
const url = 'https://example.com/v1/orgs/example/vulnerabilities/example/vex/csaf';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/vulnerabilities/example/vex/csaf \ --header 'Authorization: Bearer <token>'The ID matches every advisory, not withdrawn, whose ID it is or whose CVEs
contain it. The advisory has the organization’s current statements on any of those IDs, their CVEs and
the ID itself, over every release with such a statement: one product version per release, one vulnerability
per statement ID. Its tracking ID is <org slug>-<id as requested> and names the file; its revision history
has one entry per statement ever made on those IDs, across releases, recorded when an export first includes
it. Revisions keep their number, date and summary, and the version only grows, also when feed data changes
which IDs are in scope: a statement that enters later is the next revision. An ID that doesn’t resolve, or that this
organization has no statement on, is 404, whatever other organizations have. Without a CSAF namespace
(/settings) the answer is 409 vex.csafNamespaceRequired. The “Data freshness” note uses the oldest
matched_at of the releases and every source any of them depends on.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Organization (tenant) slug, e.g. alpenrobotik
A vulnerability ID, e.g. CVE-2024-3094, a GHSA or an OSV advisory ID
Responses
Section titled “Responses”CSAF
object
Example generated
{}Only for a browser session, and only when the server has a files host (AFFECTRA_FILES_URL): the file is at Location, /d/{token} on the files host, for about 60 seconds. API keys, user tokens and GitHub Actions jobs always get the file directly.
Headers
Section titled “Headers”The download link on the files host
No such object in this organization, no such organization, or the caller does not belong to it
The organization has no CSAF namespace yet (vex.csafNamespaceRequired)
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