API-Routen

Für eine vollständige Referenz und interaktive Dokumentation gehen Sie zu Einstellungen > Allgemeine Systemeinstellungen > API-Whitelist > API-Dokumentation

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

Authentifizierung

Route	Protokoll	Beschreibung
/auth	POST	Client-Authentifizierung

Sprache

Route	Protokoll	Beschreibung
/languages	GET	Alle Sprach-IDs abrufen
/languages/{id}	GET	Eine Sprache abrufen

Benutzer

Route	Protokoll	Beschreibung
/users	PUT	Einen Benutzer anlegen

Mandant

Route	Protokoll	Beschreibung
/clients	GET	Alle Clients abrufen
/clients	PUT	Einen Client anlegen
/clients/:id	GET	Einen Client abrufen
/clients/:id	POST	Einen Client aktualisieren
/clients/:id	DELETE	Einen Client löschen

Szenario-Vorlagen

Route	Protokoll	Beschreibung
/scenario-templates	GET	Alle Szenario-Vorlagen abrufen
/scenario-templates/{id}	GET	Eine Szenario-Vorlage abrufen
/scenario-templates/{id}	DELETE	Eine Szenario-Vorlage löschen
/scenario-templates/landing	POST	Den Inhalt der Landingpage der Vorlage aktualisieren

Awareness-Vorlagen

Route	Protokoll	Beschreibung
/awareness-templates	GET	Alle Awareness-Vorlagen abrufen
/awareness-templates/{id}	GET	Eine Awareness-Vorlage abrufen
/awareness-templates/{id}	DELETE	Eine Awareness-Vorlage löschen
/awareness-templates/file	POST	Den Seiteninhalt der Awareness-Vorlage aktualisieren

Anhangsvorlagen

Route	Protokoll	Beschreibung
/attachment-templates	GET	Alle Anhangsvorlagen abrufen
/attachment-templates/{id}	GET	Eine Anhangsvorlage abrufen
/attachment-templates/{id}	DELETE	Eine Anhangsvorlage löschen
/attachment-templates/variables/{id}	GET	Alle Variablen für eine Anhangsvorlage abrufen

Berichtsvorlagen

Route	Protokoll	Beschreibung
/report-templates	GET	Alle Berichtsvorlagen abrufen
/report-templates/{id}	GET	Eine Berichtsvorlage abrufen

Kampagnenvorlagen

Route	Protokoll	Beschreibung
/campaigns/templates	GET	Alle Kampagnenvorlagen abrufen

Empfängergruppen

Route	Protokoll	Beschreibung
/recipient-groups	GET	Alle Empfängergruppen abrufen
/recipient-groups	PUT	Eine Empfängergruppe erstellen
/recipient-groups/{id}	GET	Eine Empfängergruppe abrufen
/recipient-groups/{id}	POST	Details für eine Empfängergruppe aktualisieren
/recipient-groups/{id}	DELETE	Eine Empfängergruppe löschen
/campaigns/{id}/recipient-groups	GET	Alle Empfängergruppen einer Kampagne abrufen
/campaigns/{id}/recipient-groups	PUT	Eine Empfängergruppe zu einer Kampagne hinzufügen
/campaigns/{id}/recipient-groups/status	GET	Den Status der Empfängergruppe in einer Kampagne abrufen
/campaigns/{id}/recipient-groups	DELETE	Eine Empfängergruppe aus einer Kampagne entfernen
/scenarios/{id}/recipient-groups/{group}	GET	Alle Empfängergruppen für ein Szenario abrufen
/scenarios/{id}/recipient-groups/{group}	PUT	Eine Empfängergruppe zu einem Szenario hinzufügen
/scenarios/{id}/recipient-groups/{group}	DELETE	Eine Empfängergruppe aus einem Szenario entfernen

Empfänger

Route	Protokoll	Beschreibung
/recipients/{id}	GET	Einen Empfänger abrufen
/recipients/{id}	POST	Einen Empfänger aktualisieren
/recipients/{id}	DELETE	Einen Empfänger löschen
/recipients/{id}/stats	GET	Empfängerstatistiken abrufen
/recipient-groups/{id}/recipients	GET	Alle Empfänger in einer Gruppe abrufen
/recipient-groups/{id}/recipients	PUT	Einen Empfänger zu einer Gruppe hinzufügen
/recipient-groups/{id}/recipients/{externaID}	GET
/recipient-groups/{id}/recipients/{externaID}	POST
/recipient-groups/{id}/recipients/{externaID}	DELETE
/export/campaign/{id}/recipients	POST	Empfänger aus einer Kampagne in eine neue Gruppe exportieren

Benutzerdefinierte Felder für Empfänger

Route	Protokoll	Beschreibung
/recipient-custom-fields	GET	Alle benutzerdefinierten Felder abrufen
/recipient-custom-fields	PUT	Ein benutzerdefiniertes Feld erstellen
/recipient-custom-fields/{id}	GET	Ein benutzerdefiniertes Feld abrufen
/recipient-custom-fields/{id}	POST	Ein benutzerdefiniertes Feld aktualisieren
/recipient-custom-fields/{id}	DELETE	Ein benutzerdefiniertes Feld löschen

Kampagnen

Route	Protokoll	Beschreibung
/campaigns	GET	Alle Kampagnen abrufen
/campaigns	PUT	Eine Kampagne erstellen
/campaigns/{id}	GET	Eine Kampagne abrufen
/campaigns/{id}	POST	Eine Kampagne aktualisieren
/campaigns/{id}	DELETE	Eine Kampagne löschen
/campaigns/{id}/status	POST	Kampagnenstatus aktualisieren
/campaigns/{id}/test-run	POST	Den Testlauf für eine Kampagne starten
/campaigns/{id}/run-checks	POST	Die Vorabprüfungen für eine Kampagne starten
/campaigns/{id}/copy	POST	Eine Kampagne kopieren
/campaigns/{id}/stats	GET	Statistiken für eine Kampagne abrufen
/campaigns/{id}/errors	GET	Fehler für eine Kampagne abrufen

Szenarien

Route	Protokoll	Beschreibung
/campaigns/{id}/scenarios	GET	Alle Szenarien einer Kampagne abrufen
/campaigns/{id}/scenarios	PUT	Ein Szenario zu einer Kampagne hinzufügen
/campaigns/scenario/website	POST	Den Website-Inhalt des Szenarios aktualisieren
/scenarios/{id}	GET	Ein Kampagnenszenario abrufen
/scenarios/{id}	POST	Ein Kampagnenszenario aktualisieren
/scenarios/{id}	DELETE	Ein Kampagnenszenario löschen
/scenarios/{id}/message	POST	Die E-Mail eines Kampagnenszenarios aktualisieren
/scenarios/{id}/upload-eml	POST	Die E-Mail eines Kampagnenszenarios mit einer EML-Datei aktualisieren

Awareness

Route	Protokoll	Beschreibung
/campaigns/{id}/awareness	GET	Alle Awarenesss einer Kampagne abrufen
/campaigns/{id}/awareness	PUT	Eine Awareness zu einer Kampagne hinzufügen
/campaigns/awareness/website	POST	Den Website-Inhalt für eine Awareness aktualisieren
/awareness/{id}	GET	Eine Awareness abrufen
/awareness/{id}	POST	Eine Awareness aktualisieren
/awareness/{id}	DELETE	Eine Awareness löschen
/awareness/{id}/message	POST	Den E-Mail-Inhalt für eine Awareness aktualisieren
/awareness/{id}/bind-scenario	POST	Eine Awareness mit einem Szenario verknüpfen
/awareness/{id}/unbind-scenario	POST	Eine Awareness von einem Szenario trennen

Benutzerdefinierte Felder für Kampagnen

Route	Protokoll	Beschreibung
/campaign-custom-fields	GET	Alle benutzerdefinierten Felder abrufen
/campaign-custom-fields	PUT	Ein benutzerdefiniertes Feld erstellen
/campaign-custom-fields/{id}	GET	Ein benutzerdefiniertes Feld abrufen
/campaign-custom-fields/{id}	POST	Ein benutzerdefiniertes Feld aktualisieren
/campaign-custom-fields/{id}	DELETE	Ein benutzerdefiniertes Feld löschen

Kampagnenberichte

Route	Protokoll	Beschreibung
/campaigns/{id}/report	POST	Einen Bericht erstellen
/reports/{id}	GET	Einen Bericht abrufen
/reports/{id}/download	GET	Einen Bericht herunterladen

Zeitplaner

Route	Protokoll	Beschreibung
/campaigns/{id}/schedule-rules	GET	Alle Zeitplanregeln für eine Kampagne abrufen
/campaigns/{id}/schedule-rules	PUT	Eine Zeitplanregel zu einer Kampagne hinzufügen
/schedule-rules/{id}	GET	Eine Zeitplanregel abrufen
/schedule-rules/{id}	POST	Eine Zeitplanregel aktualisieren
/schedule-rules/{id}	DELETE	Eine Zeitplanregel löschen
/schedule-rules/{id}/recipient-groups	GET	Die Empfängergruppen für eine Zeitplanregel abrufen
/schedule-rules/{id}/scenarios	GET	Die Szenarien für eine Zeitplanregel abrufen
/campaigns/{id}/schedule-plan/generate	POST	Einen Zeitplan aus einer Zeitplanregel generieren
/campaigns/{id}/schedule-plan/status	GET	Den Status eines Zeitplans abrufen
/campaigns/{id}/schedule-plan	GET	Einen Zeitplan abrufen

Opfer

Route	Protokoll	Beschreibung
/campaigns/{id}/victims	GET	Alle Opfer einer Kampagne abrufen
/scenarios/{id}/victims	GET	Alle Opfer für ein Kampagnenszenario abrufen
/victims/{id}	GET	Ein Opfer abrufen
/victims/{id}/custom-field	POST	Die benutzerdefinierten Felder eines Opfers aktualisieren
/campaigns/victims/{id}/re-send/{type}	POST	Szenario oder Awareness für ein Opfer erneut senden
/victims/click-data/{id}	GET	Klickdaten eines Opfers abrufen

Diplome

Route	Protokoll	Beschreibung
/awareness-certificates/generate	POST	Für alle Empfänger in einer Kampagne ein Diplom erstellen
/awareness-certificate/{id}	GET	Ein Diplom abrufen
/awareness-certificates/download/{id}	GET	Ein Diplom herunterladen

Exporte

Route	Protokoll	Beschreibung
/export/{id}	GET	Einen Export abrufen
/export/generate	POST	Einen Kampagnenexport erstellen
/export/download/{id}	GET	Einen Export herunterladen

Benchmarks

Route	Protokoll	Beschreibung
/benchmarks	GET	Alle Benchmarks abrufen
/benchmarks	PUT	Einen Benchmark erstellen
/benchmarks/{id}	GET	Einen Benchmark abrufen
/benchmarks/{id}	POST	Einen Benchmark aktualisieren
/benchmarks{id}	DELETE	Einen Benchmark löschen

Domains

Route	Protokoll	Beschreibung
/domains	GET	Alle Domains abrufen
/domains	PUT	Eine Domain hinzufügen
/domains/{id}	DELETE	Eine Domain löschen

Vorfälle

Route	Protokoll	Beschreibung
/incidents	GET	Alle Vorfälle abrufen
/incidents/{id}	GET	Einen Vorfall abrufen
/incidents/{id}	DELETE	Einen Vorfall löschen
/incidents/{id}/message	GET	Den Nachrichteninhalt für einen Vorfall abrufen
/incidents/{id}/headers	GET	Die Nachrichten-Header für einen Vorfall abrufen
/incidents/{id}/abuse-modla-data	GET	Die Missbrauchsdaten für einen Vorfall abrufen
/incidents/{id}/send-abuse	POST	Einen Missbrauchsbericht für einen Vorfall senden

System

Route	Protokoll	Beschreibung
/system/whitelabel	POST	Whitelabel-Einstellungen aktualisieren
/system/whitelabel/logo	POST	Logo hochladen
/system/monitoring	GET	Systemüberwachungsdaten abrufen
/version	GET	Die aktuelle Softwareversion abrufen