API » SBOM-API

Mit der VulnDex API können Sie SBOM-Dateien im Format CycloneDX JSON oder GitLab JSON direkt in die Plattform importieren.
Die API ermöglicht automatisierte Uploads aus Build-Prozessen oder externen Integrationen.

SBOM-Upload

Der Entpunkt für den Upload einer SBOM-Datei lautet https://api.vulndex.at/sbom/upload.

Das folgende Beispiel zeigt den Aufruf mit cURL:

curl -X POST "https://api.vulndex.at/sbom/upload" \
  -H "Authorization: Bearer <YOUR_API_KEY_HERE>" \
  -H "Accept: application/json" \
  -F "sbom=@/path/to/your/sbom.json;type=application/json"

Erfolgreich angelegt

Wenn die Datei erfolgreich übertragen wurde, antwortet der Server mit dem Statuscode:

HTTP/1.1 204 No Content

Dies bedeutet, dass der Upload erfolgreich war und die Datei zur Analyse in die Queue aufgenommen wurde.

Fehlerbehandlung

Im Fehlerfall wird ein entsprechender HTTP-Statuscode sowie eine JSON-Antwort zurückgegeben.

HTTP/1.1 403 Forbidden
Content-Type: application/json

{
  "error": "Error description",
  "code": 0
}

Der Code bei diesem Endpoint kann einer aus der nachfolgenden Tabelle sein:

HTTP	Code	Beschreibung
401	56	Ungültiger API-Token
404	50	Kein SBOM-Projekt gefunden
400	51	Nur HTTP POST erlaubt
400	52	Keine Datei übertragen
500	55	Fehler während der Verarbeitung

VulnDex API bei Postman

Die VulnDex API steht auch als öffentlicher Postman Workspace zur Verfügung:

💡 Hinweis:
Zum Zugriff auf die API ist ein gültiger API-Token erforderlich.
Dieser kann im jeweiligen SBOM-Projekt über Teams abefragt werden.