SonarQube Reports API

Dieser Artikel beschreibt, wie Sie programmgesteuert auf SonarQube‑Sicherheitsberichte zugreifen, die in der Procurize‑Plattform gespeichert sind. Er behandelt die REST‑API zum Auflisten und Abrufen von Berichten sowie zum Herunterladen von Berichtarchiven.

Überblick

Das SonarQube Reports‑Unterrmodul ermöglicht es Organisationen, Sicherheits‑ und Code‑Qualitätsberichte, die von SonarQube erzeugt wurden, zentral zu speichern und zu verwalten. Die Procurize‑Plattform stellt diese Daten über:

Eine REST‑API zum Abrufen von Metadaten über gespeicherte Berichte
Einen Endpunkt zum Herunterladen von Bericht‑Artefakten als ZIP‑Archive

bereit. Diese Funktionalitäten ermöglichen Integrationen mit CI/CD‑Pipelines, GRC‑Systemen, internen Dashboards und Drittanbieter‑Risk‑Management‑Tools.

Authentifizierung und Autorisierung

Alle in diesem Artikel beschriebenen API‑Anfragen erfordern keine Authentifizierung.

Organisations‑ID

Eine Organisations‑ID ist für alle hier beschriebenen Anfragen erforderlich.
Sie finden sie im Einstellungs‑Panel der Organisation unter https://dashboard.procurize.ai.
Bitte beachten Sie, dass der Zugriff auf das Einstellungs‑Panel eine Autorisierung erfordert und der Zugriff auf das Einstellungs‑Panel der Organisation mindestens die Benutzerrolle Administrator in dieser Organisation voraussetzt.

ID‑Kopier‑Button

Basis‑URL

Alle REST‑API‑Endpunkte werden unter der folgenden Basis‑URL bereitgestellt:

https://api.procurize.com

SonarQube Reports REST‑API

Berichte auflisten

Ruft eine paginierte Liste von SonarQube‑Sicherheitsberichten ab, die in der Plattform gespeichert sind.

Endpunkt

GET /security/report/list

Abfrageparameter

org (erforderlich): Organisations‑ID.
version (optional): Die exakte Version der Produkte im Semantic‑Versioning‑Format.
minver (optional): Die Mindestversion der Produkte im Semantic‑Versioning‑Format.
maxver (optional): Die Höchstversion der Produkte im Semantic‑Versioning‑Format.

Bitte beachten Sie, dass mindestens einer der Parameter version, minver oder maxver für die Anfrage erforderlich ist.

Beispielanfrage

curl "https://api.procurize.com/security/report/list?org=00000000-0000-0000-0000-000000000001&version=1.0"

Beispielantwort

{
  "organizationId": "00000000-0000-0000-0000-000000000001",
  "reports": [
    {
      "projectName": "Test product",
      "id": "00000000-0000-0000-0000-000000000002",
      "reportType": "CWE Top 25",
      "reportVersion": 2024,
      "projectVersion": "1.0",
      "date": "2025-12-17T09:05:48.5946432+00:00",
      "uploadDate": "2025-12-17T09:05:48.5946432+00:00",
      "vulnerabilitiesCount": 0,
      "securityRating": "A"
    }
  ]
}

Bericht‑Archiv herunterladen

Lädt ein ZIP‑Archiv herunter, das die vollständigen SonarQube‑Bericht‑Artefakte enthält. Das Archiv beinhaltet HTML‑ und PDF‑Berichte.

Endpunkt

GET /security/report/files

org (erforderlich): Organisations‑ID.
reports (erforderlich): Array von Bericht‑IDs.

Beispielanfrage

curl "https://api.procurize.com/security/report/files?org=00000000-0000-0000-0000-000000000001&reports=00000000-0000-0000-0000-000000000002&reports=00000000-0000-0000-0000-000000000003"

Antwort

Content‑Type: application/zip
Der Antwortkörper enthält die binäre ZIP‑Datei

Clients sollten die Antwort streamen und auf die Festplatte schreiben.

Fehlerbehandlung

Die API verwendet standardmäßige HTTP‑Statuscodes.

200 OK: Anfrage erfolgreich
204 No Content: Bericht existiert nicht
400 Bad Request: Ungültige Parameter oder fehlerhafte Anfrage
500 Internal Server Error: Unerwarteter Serverfehler

Fehlerantworten enthalten einen maschinenlesbaren Fehlercode und eine für Menschen lesbare Meldung.

Siehe auch:

SonarQube Berichte Webhooks