​

Willkommen bei der Corgea-API

​

Möglichkeiten der Corgea-API

​

API-Funktionen

​

Authentifizierung & Autorisierung

• Token-Überprüfung: Überprüfen Sie API-Tokens und rufen Sie Benutzerinformationen ab
• Autorisierungsablauf: Tauschen Sie Autorisierungscodes gegen API-Tokens aus

​

Scan-APIs

• Scan starten: Neue Blast-Scans mit Datei-Uploads in Chunks für große Codebasen starten
• Scan-Ergebnisse hochladen: Scan-Berichte externer Security-Tools übermitteln
• Scans abrufen: Scan-Verlauf mit Filterung und Paginierung abrufen
• Scan-Details abrufen: Detaillierte Informationen zu einzelnen Scans abrufen
• Scan-Berichte: HTML-, SARIF- oder Markdown-Berichte für Scans generieren

​

Issue-Management-APIs

• Issues abrufen: Alle Security-Issues mit Filteroptionen auflisten
• Issue-Details abrufen: Umfassende Informationen zu einzelnen Schwachstellen abrufen
• SCA-Issues: Auf Schwachstellen aus der Software Composition Analysis (SCA) zugreifen
• Issues filtern: Nach Projekt, Repository, Dringlichkeit und weiteren Kriterien filtern

​

Richtlinienverwaltung

• Blocking Rules: Sicherheitsrichtlinien definieren und verwalten
• Regelüberprüfung: Prüfen, ob Scans gegen Blocking Rules verstoßen
• Policy Enforcement: Deployments anhand von Security-Richtlinien verhindern

​

Basis-URL

https://www.corgea.app/api/v1

https://<your-instance>.corgea.app/api/v1

​

Authentifizierung

CORGEA-TOKEN: your_api_token_here

​

Erste Schritte mit der Authentifizierung

1. API-Token abrufen: Rufen Sie Ihr API-Token in den Einstellungen Ihres Corgea-Kontos ab.
2. Token verifizieren: Bestätigen Sie über den /verify-Endpunkt, dass Ihr Token gültig ist.
3. Optional Benutzerinformationen abrufen: Fügen Sie ?user_info=true hinzu, um Angaben zum Benutzer und Unternehmen zu erhalten.

​

Authentifizierungsmethoden

curl -H "CORGEA-TOKEN: your_api_token_here" \
     https://www.corgea.app/api/v1/verify

curl https://www.corgea.app/api/v1/verify/your_token_here

​

Autorisierungsablauf

1. Leiten Sie Benutzer zur Autorisierungsseite von Corgea weiter
2. Benutzer autorisieren Ihre Anwendung und erhalten einen Autorisierungscode
3. Tauschen Sie den Code über /authorize?code=your_code gegen ein API-Token aus.

​

Response-Format

{
  "status": "ok",
  "data": { }
}

{
  "status": "error",
  "message": "Description of the error"
}

​

HTTP-Statuscodes

​

Paginierung

• page: Seitenzahl (Standard: 1)
• page_size: Anzahl der Ergebnisse pro Seite (Standard: 20, max.: 50)

{
  "status": "ok",
  "page": 1,
  "total_pages": 5,
  "data": []
}

​

Hilfe

​

Quickstart

1. API-Token abrufen: Rufen Sie das Token in den Einstellungen Ihres Corgea-Kontos ab.
2. Token verifizieren: Verwenden Sie den /verify-Endpunkt mit Header-Authentifizierung.
3. Ersten Request senden: Laden Sie einen Scanbericht hoch oder listen Sie Sicherheitsprobleme auf.