Mit der Uptrends API kannst Du mit Deinem Uptrends Account auf automatisierte Weise arbeiten: Du kannst Scripts erstellen, die die Monitoring-Einstellungen ändern. Oder Du kannst auf Daten zur Verfügbarkeit und Performance zugreifen, um Deine eigenen Auswertungen zu erstellen.

Wir unterstützen derzeit zwei API-Versionen:

  • Version 3 besteht seit langer Zeit und enthält Methoden zur Erstellung und Aktualisierung von Prüfobjekten (außer Transaktions- und Multi-step API-Prüfobjekten), Verwaltung von Prüfobjektgruppen, zum Abruf von aktuellen Status und Statistiken für Prüfobjekte und Herunterladen von Informationen über die Standorte der Checkpoint-Server (einschließlich IP-Adressen).

    Weitere Informationen findest Du in der vollständigen Dokumentation zu API v3.

  • Version 4 wurde gerade veröffentlicht und wird sich weiterentwickeln. Diese Version wirst Du benötigen, wenn Du Änderungen an Transaktionsprüfobjekten und Prüfobjekten für Multi-step API vornehmen oder Prüfobjekt-Duplikate erstellen möchtest.

    Weitere Informationen findest Du in der vollständigen Dokumentation zu API v4. Siehe Dir auch unsere OpenAPI Spezifikation und Swagger-Umgebung an.

Beide APIs lassen sich nebeneinander nutzen, aber sei Dir der Unterschiede bewusst, die für den Zugriff auf jede Version, die verwendete Terminologie und die Art, wie Daten organisiert sind, gelten.

Authentifizierungsunterschiede

Beide Versionen sind REST APIs, die die Angabe von Anmeldedaten anhand eines Basic Authentication HTTP Header erfordern.

  • Bei Version 3 wirst Du jedes Mal bei Zugriff auf die API den Benutzernamen (E-Mail-Adresse) und das Passwort eines Uptrends Operators angeben. Es kann ein beliebiger Operator verwendet werden, Du benötigst jedoch Administrator-Berechtigungen, um Daten zu ändern.
  • Bei Version 4 musst Du zunächst einen API-Account durch Angabe des Benutzernamens (E-Mail-Adresse) und des Passworts eines Uptrends Operators erstellen. Damit werden separate API-Anmeldedaten erzeugt, die Du für alle zukünftigen API-Aufrufe verwenden kannst. Der API-Account wird nicht verfallen. Du musst ihn also nur einmal erstellen. Denke daran, dass dieser API-Account mit dem Operator verknüpft ist, der ihn erstellte. Er wird also dessen Berechtigungen verwenden.