Uptrends' API | Uptrends

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.

Erhalte die neuesten Informationen zu Änderungen und neuen Funktionen der API mit unserem API Changelog.

API-Versionen

Wir bieten derzeit zwei API-Versionen an:

Version 4 ist die empfohlene Version der Uptrends API. Wenn du gerade zum ersten Mal mit der API arbeitest, ist dies die Version, die du nutzen solltest. Version 4 bietet sehr viel mehr Funktionen als Version 3.
Version 3 ist eine Vorgängerversion und verfügt über sehr viel weniger Optionen als Version 4 der API. Du solltest sie nur nutzen, wenn du bereits APIs der Version 3 implementiert hast und deine Prozesse sich darauf stützen.

Version 3 wird aktuell noch unterstützt, aber ist nicht die bevorzugte Option und wird mit der Zeit veralten. Version 3 und 4 werden eine gewisse Zeit nebeneinander existieren. Wir werden das Auslaufen von Version 3 im Voraus ankündigen, sodass ausreichend Zeit bleiben wird, den Wechsel zu Version 4 vorzunehmen.

Beide Versionen sind REST APIs, die die Angabe von Anmeldedaten anhand eines Basic Authentication HTTP Headers erfordern. Die Anmeldedaten für die Authentifizierung sind für die Versionen jeweils unterschiedlich. Weitere Informationen findest du in der zugehörigen Dokumentation.

Zudem findest du Information zur Nutzung der API in der Knowledge Base und in der API-Spezifikationsumgebung wie unten aufgeführt.

Allgemeine API-Informationen (Version 3 und 4)

cURL für API-Aufrufe nutzen

Powershell für API-Aufrufe nutzen

IP-Adressen auf Whitelists setzen

Angabe von Checkpoint-Regionen

API Version 4

Authentifizierung und Erstellen eines API-Accounts

OpenAPI Spezifikation (Swagger-Umgebung)

Dokumentation der API

Wartungszeiträume in der API

API Version 3

Dokumentation der API

Artikel in dieser Kategorie

Alert Definition API
Mit der Alert Definition API kannst du die Einstellungen für eine bestimmte Meldedefinition verwalten. Eine Meldedefinition beschreibt, wie und an wen eine Warnmeldung gesendet wird. Beispielsweise kannst du eine Warnmeldung konfigurieren, die erzeugt wird, wenn ein Fehler mehr als fünf Minuten andauert. Du kannst wählen, wer per E-Mail und SMS benachrichtigt werden soll. Die Alert Definition API unterstützt derzeit nur das Aktivieren und Deaktivieren einer Meldedefinition mit der Einstellung Active.
API Changelog
Erfahre, welche Änderungen, Updates und Verbesserungen es für die Uptrends API gibt
API version 4
Unsere Version 4 der Uptrends API lässt dich Prüfobjekte für Multi-step API und Transaktionen verwalten und modifizieren. Unsere neueste Version und unsere API wird sich weiterentwickeln.
Auswahl von Checkpoint-Regionen
Die Auswahl Ihrer Checkpoints, wenn Ihr Konto Sie auf komplette Regionen beschränkt.
Authentifizierung (Version 4)
Registrieren deines API-Accounts und wie die Authentifizierung funktioniert
Die Wahl der richtigen API-Version
Welche API erfüllt Deine Anforderungen am besten: Version 3, Version 4 oder beide?
Felder der Monitor API
Dieser Artikel beschreibt die API-Felder, die für die Arbeit mit der Monitor API wichtig sind. Die Definition eines Prüfobjekts (Monitor) enthält viele Felder. Einige Felder gelten dabei für alle Prüfobjekte (z. B. MonitorGuid, CheckInterval). Da aber unterschiedliche Prüfobjekttypen unterschiedliche Einstellungen erfordern, sind viele Felder nur für bestimmte Prüfobjekttypen relevant. Generische Prüfobjektfelder Feldname Beschreibung MonitorGuid Die eindeutige Kennung des Prüfobjekts. Dieser Wert wird zurückgegeben, wenn du ein bestehendes Prüfobjekt mit GET abrufst oder ein neues mit POST erstellst.
Monitor API
Die Endpunkte, die Teil der Monitor API (Prüfobjekt-API) sind, ermöglichen das Verwalten deiner Prüfobjekteinstellungen in Uptrends. Monitors bzw. Prüfobjekte werden von dir in Uptrends definiert, um festzulegen, was überwacht werden soll. Üblicherweise testet ein Prüfobjekt eine einzelne Webseite, eine Folge von API-Aufrufen oder den Klickpfad eines Nutzers einer Website. Die Prüfobjekt-API verfügt über mehrere Endpunkte, mithilfe derer du Prüfobjektdefinitionen erstellen, ändern, kopieren oder löschen kannst. Nachfolgend beschreiben wir diese Endpunkte.
MonitorCheck API
Daten aus Prüfobjektchecks können mithilfe der MonitorCheck API-Endpunkte, die Teil der API v4 sind, abgerufen werden. Prüfobjektchecks sind einzelne Messungen, die wir für jedes Prüfobjekt erfassen. Die MonitorCheck API ermöglicht Zugang zu diesen Rohdaten. Sobald Du sie abgerufen hast, kannst Du sie in einer Datenbank zur Offline-Analyse, für Audits oder zu Sicherungszwecken speichern. Es gibt die folgenden drei Endpunkte: MonitorCheck-Endpunkt Einsatz /MonitorCheck Gibt alle Prüfobjektcheckdaten des Accounts aus.
MonitorGroup API
Diese Seite beschreibt die verfügbaren API-Methoden zur Änderung von Prüfobjektgruppen (Monitor Groups).
Operator API
Die verfügbaren API-Methoden zur Änderung von Operators.
Operator Group API
Die verfügbaren API-Methoden zur Änderung von Operator-Gruppen.
Uptrends API v3
Nutze Version 3 der Uptrends API, um Prüfobjekte zu modifizieren (außer Prüfobjekte für Multi-step API und Transaktionen), Status-Updates zu erhalten und Checkpoint-Daten abzurufen.
Vault API
Die Vault wird verwendet um wiederverwertbare Daten, häufig sensible Daten wie Zertifikate, Public Keys und Benutzername-Password-Kombinationen, zu speichern Alle in der Vault gespeicherten Elemente werden Vault Item genannt. Vault Items sind in Vault Bereiche organisiert. Die Organisation von Elementen bzw. Items in unterschiedliche Bereiche ist auch hilfreich bei der Zugriffsbeschränkung für bestimmte Operator und Gruppen. Hier beschreiben wir die verfügbaren API-Methoden für die Verwaltung von Vault Items, Vault Bereichen und Autorisierungen für Vault Bereiche.
Wartungszeiträume in der API
Es gibt ein besonderes Set von API-Methoden, um Wartungszeiträume für ein Prüfobjekt oder für alle Prüfobjekte in einer Prüfobjektgruppe einzurichten. Object-Beschreibung für Wartungszeiträume Die folgenden MaintenancePeriod-Objekte werden in den nachfolgend beschriebenen API-Methoden verwendet: NameBeschreibungDatentypIdDie einzigartige Kennung des WartungszeitraumsIntegerScheduleModeOneTime, Daily, Weekly oder MonthlyEnumStartDateTimeStartdatum und -zeit (nur für einen einmal geplanten Zeitraum)DateTimeEndDateTimeEnddatum und -zeit eines einmal geplanten WartungszeitraumsDateTimeStartTimeDie Startzeit (“HH:mm”, eine 24-Stundennotation) eines sich wiederholenden (Daily, Weekly oder Monthly) WartungszeitraumsString (“HH:mm”)EndTimeDie Endzeit (“HH:mm”, eine 24-Stundennotation) eines sich wiederholenden (Daily, Weekly oder Monthly) WartungszeitraumsString (“HH:mm”)WeekDayDer Tag der Woche für einen Wartungszeitraum
Zugriff auf die Uptrends API mit cURL
Nutzen Sie cURL, um auf die Uptrends API zuzugreifen.
Zugriff auf die Uptrends API mit Powershell
Erfahren Sie, wie Sie mit PowerShell eine Uptrends API-Verbindung herstellen.