Die Uptrends API Version 4 ist ein sich entwickelndes Set von API-Aufrufen, mit dem du Prüfobjekt-Einrichtungen verwalten und modifizieren kannst. Die folgenden APIs werden aktuell unterstützt:

Register API

Registriere einen neuen API-Account, um auf die weiteren Methoden in dieser API zuzugreifen. Bitte schau Dir auch den Abschnitt zur Authentifizierung weiter unten an.

Monitor API

Ein Set von API-Methoden, um Prüfobjekteinstellungen zu verwalten, Du kannst

  • ein bestehendes Transaktionsprüfobjekt ändern;
  • ein bestehendes Multi-Step API Prüfobjekt ändern;
  • ein bestehendes Prüfobjekt klonen;
  • ein bestehendes Prüfobjekt löschen;
  • die Wartungszeiträume eines Prüfobjekts ändern; für weitere Informationen zum Ändern von Wartungszeiträumen über die API, lies bitte diese Dokumentation.

Vault API

Die Vault API enthält Methoden zum Hinzufügen, Ändern und Löschen von Elementen in Deinem Vault, zum Verwalten von Vault-Bereichen und den entsprechenden Berechtigungen. Für mehr Informationen, lies die Vault API Dokumentation und die Knowledge Base Artikel über den Vault.

Checkpoint API

Mit der Checkpoint API kannst Du Informationen über die Checkpoint Server abrufen, die das eigentliche Monitoring ausführen. Die Informationen enthalten IPv4 und IPv6 Adressen, die Du für die Whitelist in Deiner Firewall nutzen kannst. Für mehr Informationen, lies die Swagger Dokumentation über die Checkpoint-Endpunkte.

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.

Andere APIs

Für andere Operationen empfehlen wir API Version 3. Erfahre mehr über die Wahl von API v3 und API v4.

Zugriff auf API v4 mit Swagger

Du kannst alle API-Methoden auf unserer OpenAPI (Swagger) Spezifikationsseite: https://api.uptrends.com/v4/swagger 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 wiederum die Uptrends API in Deine eigenen Scripts oder Anwendungen integrieren kannst. Weitere Informationen über Swagger und Swagger-Tools findest Du unter Swagger.io.

Authentifizierung

Jede API-Methode erfordert, dass Du Dich anhand eines API-Accounts authentifizierst. Also musst Du zunächst einen Account erstellen. Dafür nutzen wir die Methode /Register. Bei diesem Beispiel verwenden wir die Swagger-Umgebung, um direkt auf die API zuzugreifen und die Methode Register aufzurufen. Der API-Account, den wir gerade erstellen, wird nicht verfallen. Du musst dies also nur einmal durchführen.

  1. Rufe die Swagger-Seite auf und finde und erweitere die Register POST-Methode.
  2. Klicke auf die Schaltfläche zum Ausprobieren (Try it out), um eine Anfrage zu erstellen.
  3. Gib in das Beschreibungsfeld einen einfachen Namen ein, z. B. „Mein API-Account“. Lasse das Typ-Feld frei.
  4. Klicke auf die Schaltfläche „Execute“.
  5. Dein Browser wird Dich nun auffordern, Deine Uptrends Operator-Anmeldedaten einzugeben, d. h. die E-Mail-Adresse und das Passwort für Deine übliche Anmeldung bei Uptrends.
  6. Nach der Anmeldung siehst Du, dass die Antwort Werte für einen Benutzernamen und Passwort enthält: Dies sind die Anmeldedaten für Deinen neuen API-Account.
  7. Bitte speichere diese Anmeldedaten und verwende sie zur Authentifizierung bei allen anderen API-Aufrufen.
  8. Und zu guter Letzt: Denke daran, dass dieser API-Account mit Deinem Operator verknüpft ist. Er wird also Deine Berechtigungen verwenden.