> For the complete documentation index, see [llms.txt](https://wiki.lucysecurity.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.lucysecurity.com/lucy-wiki-de/anwendungsreferenz/einstellungen/allgemeine-systemeinstellungen/api-whitelist/api-routen.md).

# API-Routen

{% hint style="success" %}
Für eine vollständige Referenz und interaktive Dokumentation gehen Sie zu **Einstellungen > Allgemeine Systemeinstellungen > API-Whitelist > API-Dokumentation**
{% endhint %}

```
Basis-URL: your-lucy-url.tld/api
```

## Authentifizierung

| Route | Protokoll                             | Beschreibung             |
| ----- | ------------------------------------- | ------------------------ |
| /auth | <mark style="color:grün;">POST</mark> | Client-Authentifizierung |

## Sprache

| Route           | Protokoll                            | Beschreibung            |
| --------------- | ------------------------------------ | ----------------------- |
| /languages      | <mark style="color:blau;">GET</mark> | Alle Sprach-IDs abrufen |
| /languages/{id} | <mark style="color:blau;">GET</mark> | Eine Sprache abrufen    |

## Benutzer

| Route  | Protokoll                            | Beschreibung           |
| ------ | ------------------------------------ | ---------------------- |
| /users | <mark style="color:gelb;">PUT</mark> | Einen Benutzer anlegen |

## Mandant

| Route        | Protokoll                               | Beschreibung               |
| ------------ | --------------------------------------- | -------------------------- |
| /clients     | <mark style="color:blau;">GET</mark>    | Alle Clients abrufen       |
| /clients     | <mark style="color:gelb;">PUT</mark>    | Einen Client anlegen       |
| /clients/:id | <mark style="color:blau;">GET</mark>    | Einen Client abrufen       |
| /clients/:id | <mark style="color:grün;">POST</mark>   | Einen Client aktualisieren |
| /clients/:id | <mark style="color:rote;">DELETE</mark> | Einen Client löschen       |

## Szenario-Vorlagen

| Route                       | Protokoll                               | Beschreibung                                         |
| --------------------------- | --------------------------------------- | ---------------------------------------------------- |
| /scenario-templates         | <mark style="color:blau;">GET</mark>    | Alle Szenario-Vorlagen abrufen                       |
| /scenario-templates/{id}    | <mark style="color:blau;">GET</mark>    | Eine Szenario-Vorlage abrufen                        |
| /scenario-templates/{id}    | <mark style="color:rote;">DELETE</mark> | Eine Szenario-Vorlage löschen                        |
| /scenario-templates/landing | <mark style="color:grün;">POST</mark>   | Den Inhalt der Landingpage der Vorlage aktualisieren |

## Awareness-Vorlagen

| Route                     | Protokoll                               | Beschreibung                                         |
| ------------------------- | --------------------------------------- | ---------------------------------------------------- |
| /awareness-templates      | <mark style="color:blau;">GET</mark>    | Alle Awareness-Vorlagen abrufen                      |
| /awareness-templates/{id} | <mark style="color:blau;">GET</mark>    | Eine Awareness-Vorlage abrufen                       |
| /awareness-templates/{id} | <mark style="color:rote;">DELETE</mark> | Eine Awareness-Vorlage löschen                       |
| /awareness-templates/file | <mark style="color:grün;">POST</mark>   | Den Seiteninhalt der Awareness-Vorlage aktualisieren |

## Anhangsvorlagen

| Route                                | Protokoll                               | Beschreibung                                   |
| ------------------------------------ | --------------------------------------- | ---------------------------------------------- |
| /attachment-templates                | <mark style="color:blau;">GET</mark>    | Alle Anhangsvorlagen abrufen                   |
| /attachment-templates/{id}           | <mark style="color:blau;">GET</mark>    | Eine Anhangsvorlage abrufen                    |
| /attachment-templates/{id}           | <mark style="color:rote;">DELETE</mark> | Eine Anhangsvorlage löschen                    |
| /attachment-templates/variables/{id} | <mark style="color:blau;">GET</mark>    | Alle Variablen für eine Anhangsvorlage abrufen |

## Berichtsvorlagen

| Route                  | Protokoll                            | Beschreibung                  |
| ---------------------- | ------------------------------------ | ----------------------------- |
| /report-templates      | <mark style="color:blau;">GET</mark> | Alle Berichtsvorlagen abrufen |
| /report-templates/{id} | <mark style="color:blau;">GET</mark> | Eine Berichtsvorlage abrufen  |

## Kampagnenvorlagen

| Route                | Protokoll                            | Beschreibung                   |
| -------------------- | ------------------------------------ | ------------------------------ |
| /campaigns/templates | <mark style="color:blau;">GET</mark> | Alle Kampagnenvorlagen abrufen |

## Empfängergruppen

| Route                                    | Protokoll                               | Beschreibung                                             |
| ---------------------------------------- | --------------------------------------- | -------------------------------------------------------- |
| /recipient-groups                        | <mark style="color:blau;">GET</mark>    | Alle Empfängergruppen abrufen                            |
| /recipient-groups                        | <mark style="color:gelb;">PUT</mark>    | Eine Empfängergruppe erstellen                           |
| /recipient-groups/{id}                   | <mark style="color:blau;">GET</mark>    | Eine Empfängergruppe abrufen                             |
| /recipient-groups/{id}                   | <mark style="color:grün;">POST</mark>   | Details für eine Empfängergruppe aktualisieren           |
| /recipient-groups/{id}                   | <mark style="color:rote;">DELETE</mark> | Eine Empfängergruppe löschen                             |
| /campaigns/{id}/recipient-groups         | <mark style="color:blau;">GET</mark>    | Alle Empfängergruppen einer Kampagne abrufen             |
| /campaigns/{id}/recipient-groups         | <mark style="color:gelb;">PUT</mark>    | Eine Empfängergruppe zu einer Kampagne hinzufügen        |
| /campaigns/{id}/recipient-groups/status  | <mark style="color:blau;">GET</mark>    | Den Status der Empfängergruppe in einer Kampagne abrufen |
| /campaigns/{id}/recipient-groups         | <mark style="color:rote;">DELETE</mark> | Eine Empfängergruppe aus einer Kampagne entfernen        |
| /scenarios/{id}/recipient-groups/{group} | <mark style="color:blau;">GET</mark>    | Alle Empfängergruppen für ein Szenario abrufen           |
| /scenarios/{id}/recipient-groups/{group} | <mark style="color:gelb;">PUT</mark>    | Eine Empfängergruppe zu einem Szenario hinzufügen        |
| /scenarios/{id}/recipient-groups/{group} | <mark style="color:rote;">DELETE</mark> | Eine Empfängergruppe aus einem Szenario entfernen        |

## Empfänger

| Route                                         | Protokoll                               | Beschreibung                                                 |
| --------------------------------------------- | --------------------------------------- | ------------------------------------------------------------ |
| /recipients/{id}                              | <mark style="color:blau;">GET</mark>    | Einen Empfänger abrufen                                      |
| /recipients/{id}                              | <mark style="color:grün;">POST</mark>   | Einen Empfänger aktualisieren                                |
| /recipients/{id}                              | <mark style="color:rote;">DELETE</mark> | Einen Empfänger löschen                                      |
| /recipients/{id}/stats                        | <mark style="color:blau;">GET</mark>    | Empfängerstatistiken abrufen                                 |
| /recipient-groups/{id}/recipients             | <mark style="color:blau;">GET</mark>    | Alle Empfänger in einer Gruppe abrufen                       |
| /recipient-groups/{id}/recipients             | <mark style="color:gelb;">PUT</mark>    | Einen Empfänger zu einer Gruppe hinzufügen                   |
| /recipient-groups/{id}/recipients/{externaID} | <mark style="color:blau;">GET</mark>    |                                                              |
| /recipient-groups/{id}/recipients/{externaID} | <mark style="color:gelb;">POST</mark>   |                                                              |
| /recipient-groups/{id}/recipients/{externaID} | <mark style="color:rote;">DELETE</mark> |                                                              |
| /export/campaign/{id}/recipients              | <mark style="color:grün;">POST</mark>   | Empfänger aus einer Kampagne in eine neue Gruppe exportieren |

## Benutzerdefinierte Felder für Empfänger

| Route                         | Protokoll                               | Beschreibung                               |
| ----------------------------- | --------------------------------------- | ------------------------------------------ |
| /recipient-custom-fields      | <mark style="color:blau;">GET</mark>    | Alle benutzerdefinierten Felder abrufen    |
| /recipient-custom-fields      | <mark style="color:gelb;">PUT</mark>    | Ein benutzerdefiniertes Feld erstellen     |
| /recipient-custom-fields/{id} | <mark style="color:blau;">GET</mark>    | Ein benutzerdefiniertes Feld abrufen       |
| /recipient-custom-fields/{id} | <mark style="color:grün;">POST</mark>   | Ein benutzerdefiniertes Feld aktualisieren |
| /recipient-custom-fields/{id} | <mark style="color:rote;">DELETE</mark> | Ein benutzerdefiniertes Feld löschen       |

## Kampagnen

| Route                      | Protokoll                               | Beschreibung                                 |
| -------------------------- | --------------------------------------- | -------------------------------------------- |
| /campaigns                 | <mark style="color:blau;">GET</mark>    | Alle Kampagnen abrufen                       |
| /campaigns                 | <mark style="color:gelb;">PUT</mark>    | Eine Kampagne erstellen                      |
| /campaigns/{id}            | <mark style="color:blau;">GET</mark>    | Eine Kampagne abrufen                        |
| /campaigns/{id}            | <mark style="color:grün;">POST</mark>   | Eine Kampagne aktualisieren                  |
| /campaigns/{id}            | <mark style="color:rote;">DELETE</mark> | Eine Kampagne löschen                        |
| /campaigns/{id}/status     | <mark style="color:grün;">POST</mark>   | Kampagnenstatus aktualisieren                |
| /campaigns/{id}/test-run   | <mark style="color:grün;">POST</mark>   | Den Testlauf für eine Kampagne starten       |
| /campaigns/{id}/run-checks | <mark style="color:grün;">POST</mark>   | Die Vorabprüfungen für eine Kampagne starten |
| /campaigns/{id}/copy       | <mark style="color:grün;">POST</mark>   | Eine Kampagne kopieren                       |
| /campaigns/{id}/stats      | <mark style="color:blau;">GET</mark>    | Statistiken für eine Kampagne abrufen        |
| /campaigns/{id}/errors     | <mark style="color:blau;">GET</mark>    | Fehler für eine Kampagne abrufen             |

## Szenarien

| Route                       | Protokoll                               | Beschreibung                                                          |
| --------------------------- | --------------------------------------- | --------------------------------------------------------------------- |
| /campaigns/{id}/scenarios   | <mark style="color:blau;">GET</mark>    | Alle Szenarien einer Kampagne abrufen                                 |
| /campaigns/{id}/scenarios   | <mark style="color:gelb;">PUT</mark>    | Ein Szenario zu einer Kampagne hinzufügen                             |
| /campaigns/scenario/website | <mark style="color:grün;">POST</mark>   | Den Website-Inhalt des Szenarios aktualisieren                        |
| /scenarios/{id}             | <mark style="color:blau;">GET</mark>    | Ein Kampagnenszenario abrufen                                         |
| /scenarios/{id}             | <mark style="color:grün;">POST</mark>   | Ein Kampagnenszenario aktualisieren                                   |
| /scenarios/{id}             | <mark style="color:rote;">DELETE</mark> | Ein Kampagnenszenario löschen                                         |
| /scenarios/{id}/message     | <mark style="color:grün;">POST</mark>   | Die E-Mail eines Kampagnenszenarios aktualisieren                     |
| /scenarios/{id}/upload-eml  | <mark style="color:grün;">POST</mark>   | Die E-Mail eines Kampagnenszenarios mit einer EML-Datei aktualisieren |

## Awareness

| Route                           | Protokoll                               | Beschreibung                                        |
| ------------------------------- | --------------------------------------- | --------------------------------------------------- |
| /campaigns/{id}/awareness       | <mark style="color:blau;">GET</mark>    | Alle Awarenesss einer Kampagne abrufen              |
| /campaigns/{id}/awareness       | <mark style="color:gelb;">PUT</mark>    | Eine Awareness zu einer Kampagne hinzufügen         |
| /campaigns/awareness/website    | <mark style="color:grün;">POST</mark>   | Den Website-Inhalt für eine Awareness aktualisieren |
| /awareness/{id}                 | <mark style="color:blau;">GET</mark>    | Eine Awareness abrufen                              |
| /awareness/{id}                 | <mark style="color:grün;">POST</mark>   | Eine Awareness aktualisieren                        |
| /awareness/{id}                 | <mark style="color:rote;">DELETE</mark> | Eine Awareness löschen                              |
| /awareness/{id}/message         | <mark style="color:grün;">POST</mark>   | Den E-Mail-Inhalt für eine Awareness aktualisieren  |
| /awareness/{id}/bind-scenario   | <mark style="color:grün;">POST</mark>   | Eine Awareness mit einem Szenario verknüpfen        |
| /awareness/{id}/unbind-scenario | <mark style="color:grün;">POST</mark>   | Eine Awareness von einem Szenario trennen           |

## Benutzerdefinierte Felder für Kampagnen

| Route                        | Protokoll                               | Beschreibung                               |
| ---------------------------- | --------------------------------------- | ------------------------------------------ |
| /campaign-custom-fields      | <mark style="color:blau;">GET</mark>    | Alle benutzerdefinierten Felder abrufen    |
| /campaign-custom-fields      | <mark style="color:gelb;">PUT</mark>    | Ein benutzerdefiniertes Feld erstellen     |
| /campaign-custom-fields/{id} | <mark style="color:blau;">GET</mark>    | Ein benutzerdefiniertes Feld abrufen       |
| /campaign-custom-fields/{id} | <mark style="color:grün;">POST</mark>   | Ein benutzerdefiniertes Feld aktualisieren |
| /campaign-custom-fields/{id} | <mark style="color:rote;">DELETE</mark> | Ein benutzerdefiniertes Feld löschen       |

## Kampagnenberichte

| Route                  | Protokoll                             | Beschreibung                |
| ---------------------- | ------------------------------------- | --------------------------- |
| /campaigns/{id}/report | <mark style="color:grün;">POST</mark> | Einen Bericht erstellen     |
| /reports/{id}          | <mark style="color:blau;">GET</mark>  | Einen Bericht abrufen       |
| /reports/{id}/download | <mark style="color:blau;">GET</mark>  | Einen Bericht herunterladen |

## Zeitplaner

| Route                                  | Protokoll                               | Beschreibung                                        |
| -------------------------------------- | --------------------------------------- | --------------------------------------------------- |
| /campaigns/{id}/schedule-rules         | <mark style="color:blau;">GET</mark>    | Alle Zeitplanregeln für eine Kampagne abrufen       |
| /campaigns/{id}/schedule-rules         | <mark style="color:gelb;">PUT</mark>    | Eine Zeitplanregel zu einer Kampagne hinzufügen     |
| /schedule-rules/{id}                   | <mark style="color:blau;">GET</mark>    | Eine Zeitplanregel abrufen                          |
| /schedule-rules/{id}                   | <mark style="color:grün;">POST</mark>   | Eine Zeitplanregel aktualisieren                    |
| /schedule-rules/{id}                   | <mark style="color:rote;">DELETE</mark> | Eine Zeitplanregel löschen                          |
| /schedule-rules/{id}/recipient-groups  | <mark style="color:blau;">GET</mark>    | Die Empfängergruppen für eine Zeitplanregel abrufen |
| /schedule-rules/{id}/scenarios         | <mark style="color:blau;">GET</mark>    | Die Szenarien für eine Zeitplanregel abrufen        |
| /campaigns/{id}/schedule-plan/generate | <mark style="color:grün;">POST</mark>   | Einen Zeitplan aus einer Zeitplanregel generieren   |
| /campaigns/{id}/schedule-plan/status   | <mark style="color:blau;">GET</mark>    | Den Status eines Zeitplans abrufen                  |
| /campaigns/{id}/schedule-plan          | <mark style="color:blau;">GET</mark>    | Einen Zeitplan abrufen                              |

## Opfer

| Route                                  | Protokoll                             | Beschreibung                                              |
| -------------------------------------- | ------------------------------------- | --------------------------------------------------------- |
| /campaigns/{id}/victims                | <mark style="color:blau;">GET</mark>  | Alle Opfer einer Kampagne abrufen                         |
| /scenarios/{id}/victims                | <mark style="color:blau;">GET</mark>  | Alle Opfer für ein Kampagnenszenario abrufen              |
| /victims/{id}                          | <mark style="color:blau;">GET</mark>  | Ein Opfer abrufen                                         |
| /victims/{id}/custom-field             | <mark style="color:grün;">POST</mark> | Die benutzerdefinierten Felder eines Opfers aktualisieren |
| /campaigns/victims/{id}/re-send/{type} | <mark style="color:grün;">POST</mark> | Szenario oder Awareness für ein Opfer erneut senden       |
| /victims/click-data/{id}               | <mark style="color:blau;">GET</mark>  | Klickdaten eines Opfers abrufen                           |

## Diplome

| Route                                 | Protokoll                             | Beschreibung                                              |
| ------------------------------------- | ------------------------------------- | --------------------------------------------------------- |
| /awareness-certificates/generate      | <mark style="color:grün;">POST</mark> | Für alle Empfänger in einer Kampagne ein Diplom erstellen |
| /awareness-certificate/{id}           | <mark style="color:blau;">GET</mark>  | Ein Diplom abrufen                                        |
| /awareness-certificates/download/{id} | <mark style="color:blau;">GET</mark>  | Ein Diplom herunterladen                                  |

## Exporte

| Route                 | Protokoll                             | Beschreibung                    |
| --------------------- | ------------------------------------- | ------------------------------- |
| /export/{id}          | <mark style="color:blau;">GET</mark>  | Einen Export abrufen            |
| /export/generate      | <mark style="color:grün;">POST</mark> | Einen Kampagnenexport erstellen |
| /export/download/{id} | <mark style="color:blau;">GET</mark>  | Einen Export herunterladen      |

## Benchmarks

| Route            | Protokoll                               | Beschreibung                  |
| ---------------- | --------------------------------------- | ----------------------------- |
| /benchmarks      | <mark style="color:blau;">GET</mark>    | Alle Benchmarks abrufen       |
| /benchmarks      | <mark style="color:gelb;">PUT</mark>    | Einen Benchmark erstellen     |
| /benchmarks/{id} | <mark style="color:blau;">GET</mark>    | Einen Benchmark abrufen       |
| /benchmarks/{id} | <mark style="color:grün;">POST</mark>   | Einen Benchmark aktualisieren |
| /benchmarks{id}  | <mark style="color:rote;">DELETE</mark> | Einen Benchmark löschen       |

## Domains

| Route         | Protokoll                               | Beschreibung           |
| ------------- | --------------------------------------- | ---------------------- |
| /domains      | <mark style="color:blau;">GET</mark>    | Alle Domains abrufen   |
| /domains      | <mark style="color:gelb;">PUT</mark>    | Eine Domain hinzufügen |
| /domains/{id} | <mark style="color:rote;">DELETE</mark> | Eine Domain löschen    |

## Vorfälle

| Route                            | Protokoll                               | Beschreibung                                      |
| -------------------------------- | --------------------------------------- | ------------------------------------------------- |
| /incidents                       | <mark style="color:blau;">GET</mark>    | Alle Vorfälle abrufen                             |
| /incidents/{id}                  | <mark style="color:blau;">GET</mark>    | Einen Vorfall abrufen                             |
| /incidents/{id}                  | <mark style="color:rote;">DELETE</mark> | Einen Vorfall löschen                             |
| /incidents/{id}/message          | <mark style="color:blau;">GET</mark>    | Den Nachrichteninhalt für einen Vorfall abrufen   |
| /incidents/{id}/headers          | <mark style="color:blau;">GET</mark>    | Die Nachrichten-Header für einen Vorfall abrufen  |
| /incidents/{id}/abuse-modla-data | <mark style="color:blau;">GET</mark>    | Die Missbrauchsdaten für einen Vorfall abrufen    |
| /incidents/{id}/send-abuse       | <mark style="color:grün;">POST</mark>   | Einen Missbrauchsbericht für einen Vorfall senden |

## System

| Route                   | Protokoll                             | Beschreibung                           |
| ----------------------- | ------------------------------------- | -------------------------------------- |
| /system/whitelabel      | <mark style="color:grün;">POST</mark> | Whitelabel-Einstellungen aktualisieren |
| /system/whitelabel/logo | <mark style="color:grün;">POST</mark> | Logo hochladen                         |
| /system/monitoring      | <mark style="color:blau;">GET</mark>  | Systemüberwachungsdaten abrufen        |
| /version                | <mark style="color:blau;">GET</mark>  | Die aktuelle Softwareversion abrufen   |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://wiki.lucysecurity.com/lucy-wiki-de/anwendungsreferenz/einstellungen/allgemeine-systemeinstellungen/api-whitelist/api-routen.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.