File a proposal (member; member API keys may)
const url = 'https://example.com/v1/orgs/example/proposals';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"kind":"vex_statement","release":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","payload":{},"evidence":{"edges":[{"from":"example","relation":"example","to":"example","properties":{}}],"traversals":["example"],"explanation":"example"},"basis":"carry_over","based_on":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/v1/orgs/example/proposals \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "kind": "vex_statement", "release": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "payload": {}, "evidence": { "edges": [ { "from": "example", "relation": "example", "to": "example", "properties": {} } ], "traversals": [ "example" ], "explanation": "example" }, "basis": "carry_over", "based_on": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'The payload is the body of the write route (POST …/releases/{release}/vex or POST …/cpe-mappings) and is validated the same way, with the same codes. Every evidence edge must exist in the organization’s data (proposal.evidenceUnknown, params.edge its index); the stored edges carry the properties the data has. A carry_over names the current statement on another release it carries over and needs an exact path signature match (proposal.notCarryOver, proposal.basisMismatch). A new VEX proposal supersedes the pending one for the same release and vulnerability. A unit_release_link (UnitLinkPayload) names one of the organization’s releases (proposal.releaseUnknown otherwise) and cites a reported edge of a unit whose last report has the text (proposal.evidenceMissing); a text that has an alias is alias.exists, and a newer proposal for the same text, whatever its case, supersedes the pending one. Who proposed it comes from the credential.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Organization (tenant) slug, e.g. alpenrobotik
Request Bodyrequired
Section titled “Request Bodyrequired”object
Unit_release_link: units that report a version text run a release; accepted, it is a release alias
The release a vex_statement is about; a unit_release_link names it in its payload
The body of POST …/releases/{release}/vex or POST …/cpe-mappings, or a UnitLinkPayload
object
object
object
Node ID
An ontology relation
Node ID
As the data has them; what a client sends is ignored
object
Read tools the agent ran, by name, e.g. explain_finding, neighbours
Plain text; never render it as HTML or Markdown
Carry_over: a statement on another release with an exact path signature match; analysis: the agent’s own argument
The VEX statement a carry_over carries over
Responses
Section titled “Responses”Filed
object
Unit_release_link: units that report a version text run a release; accepted, it is a release alias
As filed; an edited accept leaves it unchanged
object
object
object
Node ID
An ontology relation
Node ID
As the data has them; what a client sends is ignored
object
Read tools the agent ran, by name, e.g. explain_finding, neighbours
Plain text; never render it as HTML or Markdown
Carry_over: a statement on another release with an exact path signature match; analysis: the agent’s own argument
Key:
The client’s name (OAuth client or API key name), for display only
User ID
The statement, mapping or release alias written on accept
Example
{ "kind": "vex_statement", "basis": "carry_over", "status": "pending"}An invalid payload or evidence, or a carry-over that isn’t one
Role below member
No such object in this organization, no such organization, or the caller does not belong to it
Another proposal for the finding or text was filed at the same moment, the mapping is built in, or the text has an alias (alias.exists)
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