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.
Um API-Aufrufe durchzuführen, musst du einen API-Account erstellen. Siehe Register API, um mehr zu den Schritten zu erfahren.
Zugriff auf API v4 mit Swagger
Du kannst alle API-Methoden auf unserer OpenAPI (Swagger) Spezifikationsseite sehen. Die Seite beschreibt detailliert alle API-Methoden und du kannst jede Methode einzeln ausführen.
Darüber hinaus kannst du unsere Swagger-Spezifikation zusammen mit Swagger Codegen nutzen, um Client-Code zu erzeugen, mit dem du die Uptrends API in deine eigenen Scripts oder Anwendungen integrieren kannst. Weitere Informationen über Swagger und Swagger-Tools findest du unter 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 Im Artikel Authentifizierung werden die Schritte detailliert erläutert, um einen Account zu registrieren, und es wird dargelegt, wie die Authentifizierung funktioniert.
Monitor API
Dies ist eine Reihe von API-Methoden zur Verwaltung von Prüfobjektdefinitionen. Alles was du zur Automatisierung deiner Prüfobjektverwaltung benötigst, wird in der API-Dokumentation für Prüfobjekte beschrieben.
MonitorCheck API
Die MonitorCheck API enthält eine Reihe von API-Methoden zum Zugriff auf rohe Prüfobjektdaten für jeden einzelnen Check. 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 weitere Operationen bei Prüfobjekten, die in diesen Gruppen enthalten sind, beispielsweise das Aktivieren und Deaktivieren aller Prüfobjekte. Weitere Informationen findest du in der Monitor Group API-Dokumentation.
Operator API
Die Operator API ist eine Reihe von 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, wodurch du dieselben Einstellungen für diese Operatoren hinsichtlich Zugriffsberechtigung und Warnmeldungen vornehmen kannst. 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 Definitions API
Dies sind API-Methoden für die Handhabung von Meldedefinitionen. Es gibt eine Dokumentation in den API-Dokumenten zu Meldedefinitionen.
Vault API
Die Vault API enthält Methoden für das Hinzufügen, Aktualisieren und Löschen von Elementen in deiner Vault. Darüber hinaus kannst du Vault Bereiche und zugehörige Autorisierungen verwalten. Weitere Informationen findest du in der Vault API-Dokumentation und im Vault-Artikel in der Knowledge Base.
Checkpoints API
Anhand der Checkpoint API kannst du Informationen über die Checkpoint-Standorte/-Server abrufen, mit denen das tatsächliche Monitoring durchgeführt wird. Die Checkpoint-Serverinformationen enthalten die IPv4- und IPv6-Adressen, die du in deiner Firewall auf die Whitelist setzen kannst. Weitere Informationen findest du in der Swagger-Dokumentation für die Checkpoint-Endpunkte.