> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corgea.app/llms.txt
> Use this file to discover all available pages before exploring further.

# API-Referenz

> Erste Schritte mit der Corgea-API

# Willkommen bei der Corgea-API

Über die Corgea-API können Sie die Application-Security-Plattform von Corgea programmatisch nutzen. Automatisieren Sie Security-Scans, rufen Sie Security-Issues ab, verwalten Sie Fixes und integrieren Sie Corgea in Ihren Entwicklungsworkflow.

## Möglichkeiten der Corgea-API

<CardGroup cols={2}>
  <Card title="Scan Management" icon="radar">
    Security-Scans starten, Scan-Ergebnisse hochladen und den Scan-Fortschritt überwachen
  </Card>

  <Card title="Issue Management" icon="bug">
    Details zu Schwachstellen abrufen, den Issue-Status verwalten und die Behebung nachverfolgen
  </Card>

  <Card title="Auto-Fixes abrufen" icon="wand-magic-sparkles">
    Auf KI-generierte Security-Fixes und Patches für erkannte Schwachstellen zugreifen
  </Card>

  <Card title="CI/CD-Integration" icon="code-branch">
    Security-Scans in Ihre Continuous-Integration-Pipelines integrieren
  </Card>
</CardGroup>

## 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

Senden Sie alle API-Requests an eine der folgenden Adressen.

Multi-Tenant-Umgebung:

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

Single-Tenant-Umgebung:

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

## Authentifizierung

Die Corgea-API verwendet API-Key-Authentifizierung. Übergeben Sie Ihr API-Token im Request-Header:

```bash theme={null}
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

**Header-basierte Authentifizierung** (empfohlen):

```bash theme={null}
curl -H "CORGEA-TOKEN: your_api_token_here" \
     https://www.corgea.app/api/v1/verify
```

**Pfadbasierte Authentifizierung** (veraltet):

```bash theme={null}
curl https://www.corgea.app/api/v1/verify/your_token_here
```

### Autorisierungsablauf

Für Anwendungen, die Benutzer authentifizieren müssen:

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.

<Note>
  Einige Endpunkte wie `/verify/{token}` und `/authorize` erfordern keine Authentifizierung. Die jeweiligen Anforderungen finden Sie in der Dokumentation des Endpunkts.
</Note>

## Response-Format

Alle API-Responses werden im JSON-Format zurückgegeben. Erfolgreiche Responses enthalten das Feld `status`:

```json theme={null}
{
  "status": "ok",
  "data": { }
}
```

Fehler-Responses enthalten eine aussagekräftige Meldung:

```json theme={null}
{
  "status": "error",
  "message": "Description of the error"
}
```

## HTTP-Statuscodes

Die API verwendet standardmäßige HTTP-Statuscodes:

| Code  | Beschreibung                                                              |
| ----- | ------------------------------------------------------------------------- |
| `200` | Anfrage erfolgreich                                                       |
| `400` | Ungültiger Request – fehlerhafte Parameter oder fehlerhafter Request-Body |
| `401` | Nicht autorisiert - ungültige oder fehlende Authentifizierung             |
| `404` | Ressource nicht gefunden                                                  |
| `429` | Rate Limit überschritten                                                  |
| `500` | Interner Serverfehler                                                     |

## Paginierung

Endpunkte, die Listen zurückgeben, unterstützen die Paginierung über Query-Parameter:

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

Paginierte Antworten enthalten:

```json theme={null}
{
  "status": "ok",
  "page": 1,
  "total_pages": 5,
  "data": []
}
```

## Hilfe

<CardGroup cols={2}>
  <Card title="Authentifizierungsleitfaden" icon="key" href="/de/api-reference/authentication">
    API-Requests authentifizieren
  </Card>

  <Card title="Support" icon="life-ring" href="https://corgea-community.slack.com/join/shared_invite/zt-2cjmxat2f-Znvd06nP2gn9RYOSWrZI2A#">
    Unterstützung durch unser Support-Team erhalten
  </Card>
</CardGroup>

## Quickstart

In drei Schritten zur ersten Nutzung der Corgea-API:

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](https://docs.corgea.app/api-reference/uploading-3rd-party-scan/upload-scan) oder [listen Sie Sicherheitsprobleme auf](https://docs.corgea.app/api-reference/issues/list-all-issues).

Weitere Informationen zu den verfügbaren Funktionen finden Sie bei den API-Endpunkten in der Seitenleiste.