Add a CSAF product mapping (admin). Findings update on the worker's next run.
const url = 'https://example.com/v1/orgs/example/csaf-mappings';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"purl":"example","provider":"example","kind":"model_number","value":"example"}'};
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/csaf-mappings \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "purl": "example", "provider": "example", "kind": "model_number", "value": "example" }'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
The package without version, e.g. pkg:generic/phoenixcontact/charx-sec-3150. Not for ecosystems OSV covers (npm, PyPI, Debian, …).
The CSAF provider’s slug, as GET …/csaf-products lists it, e.g. siemens
What of a CSAF product the value names
The model number, SKU or product name as the advisories give it. Stored trimmed, in lower case, with single spaces.
Responses
Section titled “Responses”Created
object
Pkg:type/namespace/name, lower case
The CSAF provider’s slug
What of a CSAF product the value names
Trimmed, lower case, single spaces
The provider’s advisories (not withdrawn) naming the value. 0 usually means a typo, or a provider that isn’t loaded.
Example
{ "kind": "model_number"}Mapping.purlInvalid, mapping.purlVersioned, mapping.purlCoveredByOsv, mapping.csafProviderUnknown, mapping.csafKindInvalid, mapping.csafValueInvalid (params.max), or request.invalidJson
Caller is not an admin
The organization has this mapping already (request.alreadyExists)
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