Die Enterprise Alert REST-API ist für eine komfortable Integration mit einer Vielzahl von Drittanbieter-Anwendungen konzipiert. Zur Übermittlung von Ereignissen an Enterprise Alert werden HTTP POSTs mit beliebigem(!) JSON/XML/Textbody verwendet, welcher Ereignisdetails und -parameter enthält. Die API ist äußerst flexibel auf Ihre Bedürfnisse anpassbar, da sie kein spezielles Format benötigt. Stattdessen können Sie das Format Ihres Quellsystemes (z. B. VMware, Splunk, OMS usw.) ohne jegliche Änderung, an Nachricht oder API, einfach an Enterprise Alert weiterleiten lassen.
Für jedes dieser Systeme können Sie im Systemabschnitt von Enterprise Alert eine eigene REST-Ereignisquelle erstellen. Die Authentifizierung zwischen Quellsystem und Enterprise Alert kann über einen API-Key oder auch Basic Authentication erfolgen. Weitere Einzelheiten finden Sie in unserem aktualisierten Dokument Erste Schritte.
Die Enterprise Alert REST-API wird inklusive der Online-Dokumentation von OpenAPI („Swagger“) und einem Swagger UI „API Explorer“ bereitgestellt. Sie können Swagger aus der REST Eventquelle heraus öffnen, um so an die API-Beschreibung zu gelangen. Sie enthält Authentifizierungsdetails und ermöglicht es Ihnen, die API von Ihrem Webbrowser aus zu testen. Wie bereits erwähnt, ist die REST-API derzeit ausschließlich auf den Empfang von Ereignissen von Ihren Drittsystemen beschränkt, um automatische Benachrichtigungen an die zuständigen Ziele innerhalb Enterprise Alerts auszulösen. Wir wollen jedoch mittelfristig weitere Handler hinzufügen, z.B. für die Nutzerverwaltung oder den Abruf von Warnmeldungen. Die REST-API ist Teil der OpenAPI-Edition oder jeder „höheren“ Edition von Enterprise Alert.
Integrationsvorteile:
Einsatzszenarien:
Eine Rest API in Enterprise Alert anlegen
In Enterprise Alert können Sie auf dem Dashboard der rechten Seite die Endpunkte finden. Kopieren Sie von dort die REST API URL und kombinieren Sie ihn mit dem zuvor gesicherten API Key, diesen fügen Sie am Ende der URL hinter “apiKey=” ein.
Anlegen von Alarmierungen in Enterprise Alert basierend auf WebHook/REST API Ereignissen
Um aus den Events, die über die zuvor erstellte REST Eventquelle eingehen, Alarmierungsrichtlinien zu erstellen, befolgen Sie bitte die folgenden Schritte:
Alarmierungen innerhalb der Enterprise Alert App
Die Enterprise Alert App erlaubt es Nutzern, ihre Alarme einfach einzusehen und zu bearbeiten, ohne sich zuvor im Web Portal einzuloggen. Untenstehend finden Sie ein Beispiel für Alarmdetails eines offenen Alarms und einen geschlossenen Alarm in unserer App.