Die Uptrends API Version 4 ist ein sich entwickelndes Set von API-Endpunkten und -Methoden, mit denen du Informationen über deine Monitoring-Einrichtung erhalten und modifizieren kannst. Stelle sicher, dass du dich für einen API-Account registriert hast , um API-Aufrufe zu senden.
Zugriff auf API v4 mit Swagger
Alle Uptrends API-Methoden sind auf der Uptrends OpenAPI (Swagger) Seite verfügbar. Die Seite beschreibt detailliert alle API-Methoden und du kannst jede Methode einzeln ausführen.
Du kannst unsere Swagger-Spezifikation zusammen mit Swagger Codegen nutzen, um Client-Code zu erzeugen und die Uptrends API in deine eigenen Skripte oder Anwendungen zu integrieren. Um mehr über Swagger und Swagger Tools zu erfahren, besuche Swagger.io .
Endpunkte
Es gibt derzeit die folgenden API-Endpunkte:
Register API
Der erste Schritt, den du unternehmen musst: Registriere einen API-Account, um auf die anderen Methoden in dieser API zuzugreifen Weitere Informationen zu detaillierten Schritten, um dich für einen Account zu registrieren, und wie die Authentifizierung funktioniert, findest du unter Authentifizierung .
Monitor API
Die Monitor API enthält Methoden zur Verwaltung von Prüfobjektdefinitionen. Weitere Informationen findest du in der Monitor API-Dokumentation .
MonitorCheck API
Die MonitorCheck API enthält Methoden zum Abruf von rohen Prüfobjekt-Kontrolldaten für jede einzelne Prüfung. Weitere Informationen findest du in der MonitorCheck API-Dokumentation .
Monitor Group API
Die Monitor Group API enthält Methoden zum Hinzufügen, Aktualisieren und Löschen von Prüfobjektgruppen sowie für Operationen in Prüfobjektgruppen (beispielsweise das Aktivieren und Deaktivieren aller Prüfobjekte). Weitere Informationen findest du in der Monitor Group API-Dokumentation .
Operator API
Die Operator API enthält Methoden für das Hinzufügen, Aktualisieren und Löschen von Operatoren. Ein Operator ist ein im Uptrends Account eingerichteter Nutzer. Du kannst diese API zur Automatisierung des Nutzermanagements bei deinem Account verwenden. Neben dem Verwalten der Nutzer-Logins und Einstellungen für jeden einzelnen Operator (einschließlich Sprach- und Kommunikationseinstellungen) ermöglicht diese API auch das Verwalten von Dienstplänen für jeden Operator. Weitere Informationen findest du in der Operator API-Dokumentation .
Operator Group API
Die Operator Group API enthält Methoden für das Hinzufügen, Aktualisieren und Löschen von Operator-Gruppen. Du kannst Operatoren in Gruppen verwalten, um dieselben Einstellungen für diese Operatoren einschließlich Zugriffsberechtigung und Warnmeldungen vorzunehmen. Mit der Operator Group API kannst du auch Dienstpläne für alle Operatoren einer Gruppe einrichten. Weitere Informationen findest du in der Operator Group API-Dokumentation .
Alert API
Die Alert API enthält Methoden zur Verwaltung von Alarmen. Weitere Informationen findest du in der Alert API .
Alert Definitions API
Die Alert Definition API enthält Methoden zur Verwaltung von Meldedefinitionen. Weitere Informationen findest du in der Alert Definition API .
Vault API
Die Vault API enthält Methoden für das Hinzufügen, Aktualisieren und Löschen von Elementen in deiner Vault und in Vault Bereichen sowie für zugehörige Autorisierungen. Weitere Informationen findest du in der Vault API-Dokumentation und in der Vault .
Checkpoints API
Die Checkpoint API enthält Methoden, anhand derer du Informationen über Checkpoint-Standorte/-Server, mit denen das tatsächliche Monitoring durchgeführt wird, abrufen kannst. Die Checkpoint-Server-Daten umfassen IPv4- und IPv6-Adressen, die du zur Whitelist deiner Firewall hinzufügen kannst. Weitere Informationen findest du in der Swagger-Dokumentation zu den Checkpoint-Endpunkten .