Die Uptrends API Version 4 ist ein umfassendes Set an Endpunkten, mithilfe derer du anhand von API-Aufrufen mit der Uptrends Webanwendung interagieren kannst. Nutze die API, um:
- auf Echtzeit-Monitoring-Daten zuzugreifen und Website- und Webservice-Performance zu überwachen.
- Performance-Metriken, Verfügbarkeitsstatistiken und Verlaufsdaten zur Analyse und zum Reporting abzurufen.
- Alarme, Accounteinstellungen, Nutzerberechtigungen und Prüfobjektkonfigurationen zu verwalten.
- Skripte einzurichten, um Prüfobjekte zu erstellen, zu aktualisieren und zu löschen und um Einrichtungskonfigurationen von Prüfobjekten zu verwalten.
Die neuesten Informationen über Änderungen an der API und neue Funktionen findest du im API Changelog.
Zugriff auf die API
Um die Uptrends API v4 aufzurufen und zu nutzen, benötigst du zunächst einen API-Account. Sobald dieser eingerichtet ist, sind alle Uptrends API-Endpunkte der Uptrends API v4 Dokumentation verfügbar. Diese interaktive Dokumentation beschreibt alle API-Methoden im Detail und bietet eine Testumgebung, in der du API-Aufrufe direkt testen und ausprobieren kannst.
Du kannst unsere Swagger-Spezifikation zudem mit Swagger Codegen nutzen, um Client-Code zu erzeugen und die Uptrends API in deine eigenen Skripte oder Anwendungen zu integrieren. Mehr über Swagger und seine Tools findest du unter Swagger.io.
API-Endpunkte
Es gibt derzeit die folgenden API-Endpunkte:
Account API
Die Account API bietet Methoden zur Erstellung, Aktualisierung, Löschung und Verwaltung deiner Accountdaten und Abonnementdetails. Du kannst auf Accountdaten, einschließlich Rechnungsinformationen und Nutzungsstatistiken, zugreifen, um dein Uptrends Abonnement und den Ressourcenverbrauch zu überwachen.
Rufe Daten wie Ablaufdaten des Accounts, Credit-Verbrauch pro Prüfobjekttyp und die Operator-Anzahl in deinem Account ab.
Alert API
Die Alert API bietet Methoden für die Erstellung, Aktualisierung, Löschung und Verwaltung von Alarmierungsinformationen spezifischer Prüfobjekte oder Prüfobjektgruppen. Du kannst auf Alarmierungsdaten, einschließlich Alarmierungs-Zeitstempel, Alarmierungstypen, Fehlerbeschreibungen und betroffene Prüfobjekte zugreifen, um Probleme und Unterbrechungen deiner Webservices effektiv in Echtzeit zu verfolgen.
Weitere Informationen findest du unter Alert API.
Alert Definitions API
Die Alert Definitions API bietet Methoden für die Erstellung, Aktualisierung, Löschung und Verwaltung von Meldedefinitionen, die spezifizieren, wie Alarme gesendet werden und wer sie erhält, basierend auf Eskalationsstufen. Du kannst Details wie Namen von Meldedefinitionen und ihren Status abrufen, um sicherzustellen, dass Alarme wirksam gehandhabt werden.
Weitere Informationen findest du unter Alert Definition API.
Checkpoints API
Die Checkpoint API bietet Methoden für die Erstellung, Aktualisierung, Löschung und Verwaltung von Checkpoint-Standorten oder Servern, die das tatsächliche Monitoring an bestimmten Standorten ausführen.
Du kannst Checkpoint-Daten wie Checkpoint-Name, Checkpoint-Standortcode, hohe Verfügbarkeit und primären Checkpoint-Status, Fähigkeiten der IPv6-Unterstützung und Daten zur geografischen Region abrufen. Du kannst auch Server-Daten einschließlich IPv4- und IPv6-Adressen abrufen, die du zur Whitelist deiner Firewall hinzufügen kannst.
Damit kannst du Netzwerkkonfigurationen prüfen und deine Websites und Webservices an unterschiedlichen geografischen Standorten überwachen.
Dashboard API
Die Dashboard API bietet Methoden für die Erstellung, Aktualisierung und Verwaltung von Dashboard-Konfigurationen und ihren Filtereinstellungen. Du kannst Dashboard-Darstellungen ändern, um benutzerdefinierte Monitoring-Anzeigen zu erstellen, die deinen besonderen Anforderungen entsprechen.
Du kannst auf Details wie Dashboard-Namen, Beschreibungen, Prüfobjektauswahl, Prüfobjektgruppen, Checkpoint-Filter und andere Anzeigeeinstellungen zugreifen.
Integration API
Die Integration API bietet Methoden für die Erstellung, Aktualisierung, Löschung und Verwaltung von Uptrends-eigenen und Fremdanbieterintegrationen in deinem Account.
Du kannst auf Details wie Integrationsnamen, -typen, Berechtigungen und weitere Felder zugreifen, um eine Verbindung zu externen Services für Alarmierungsbenachrichtigungen und Incident Management Workflows für deine gesamte Konfiguration einzurichten.
Monitor API
Die Monitor API bietet Methoden zur Erstellung, Aktualisierung, Löschung und Verwaltung von Prüfobjekten in deinem Account. Du kannst Monitoring-Einrichtungen konfigurieren und die Verfügbarkeit und Performance deiner Websites, Webservices und APIs regelmäßig überwachen.
Du kannst auf Monitoring-Daten wie Prüfobjektname, -typ, Status, Überwachungsintervall, Checkpoints und weitere Felder zugreifen.
Weitere Informationen findest du unter Monitor API.
MonitorCheck API
Die MonitorCheck API bietet Methoden zum Abruf detaillierter Monitoring-Ergebnisse für jede einzelne Prüfung. Du kannst auf rohe Prüfergebnisse und Performance-Metriken zugreifen, um die Monitoring-Trends zu verfolgen und Probleme mit einer Ursachenanalyse beheben.
Du kannst auf Details wie Prüf-Zeitstempel, Fehlercodes, Fehlerbedingungen und andere Performance-Daten zugreifen.
Weitere Informationen findest du unter MonitorCheck API.
Monitor Group API
Die Monitor Group API bietet Methoden für die Erstellung, Aktualisierung, Löschung und Verwaltung von Prüfobjektgruppen.
Du kannst auf Details wie Namen von Prüfobjektgruppen, Status, Credit-Verbrauch nach Prüfobjekttyp, Prüfobjekte der Gruppe und andere Felder zugreifen. Damit kannst du Prüfobjekte verwalten und Massenoperationen wie das Starten, Stoppen oder Konfigurieren mehrerer Prüfobjekte gleichzeitig ausführen.
Weitere Informationen findest du unter Monitor Group API.
Operator API
Die Operator API bietet Methoden zur Erstellung, Aktualisierung, Löschung und Verwaltung von Operatoren in deinem Uptrends Account. Ein Operator ist ein Uptrends Account-Nutzer.
Du kannst auf Operatoren-Daten wie Operatornamen, E-Mail-Adressen, Telefonnummern, Spracheinstellungen, Dienstpläne und andere Einstellungen zugreifen. Damit kannst du Nutzer ganz einfach verwalten, einschließlich ihrer Berechtigungen, Anmeldedaten und Dienstplaneinstellungen.
Weitere Informationen findest du unter Operator API.
Operator Group API
Die Operator Group API bietet Methoden zur Erstellung, Aktualisierung, Löschung und Verwaltung von Operator-Gruppen. Du kannst Operatoren in Gruppen verwalten, um dieselben Einstellungen für diese Operatoren einschließlich Zugriffsberechtigung und Warnmeldungen vorzunehmen. Damit kannst du mehrere Operatoren verwalten und Massenoperationen wie Einrichten von Dienstplänen und Konfigurieren von Zugriffsberechtigungen für alle Mitglieder gleichzeitig ausführen.
Weitere Informationen findest du unter Operator Group API.
OutgoingPhoneNumber API
Die OutgoingPhoneNumber API bietet Methoden für den Abruf und das Verwalten von ausgehenden Telefonnummern, die für die Integrationen zur Telefonalarmierung genutzt werden, um Sprachanrufe und SMS-Benachrichtigungen für Monitoring-Alarme zu erhalten.
PrivateLocation API
Die PrivateLocation API bietet Methoden für die Erstellung, Aktualisierung, Löschung und Verwaltung von Private Locations. Mit Private Locations kannst du Anwendungen innerhalb deines internen Netzwerks überwachen, die nicht von öffentlichen Checkpoints erreichbar sind.
Du kannst auf Details wie Namen von Private Locations, Anzahl Server, Serverstatus, Checkpoint-Standorte, Warnmeldedaten, zugehörige Berechtigungen und andere Felder zugreifen.
Weitere Iinformationen findest du unter Private Location API.
PublicStatusPage API
Die PublicStatusPage API bietet Methoden für die Erstellung, Aktualisierung, Löschung und Verwaltung von Public Status Pages, Statusseiten, die öffentlich einsehbare Dashboards enthalten, mit denen du deine Kunden über den Status deiner Website auf den Laufenden hältst.
Du kannst auf Details wie Name der Statusseite, Beschreibungen, Prüfobjektauswahl, Anzeigekonfigurationen, SLA-Status und andere Felder zugreifen.
Register API
Die Register API ermöglicht dir, ein neuen API-Account zu erstellen, um auf Uptrends API-Services zuzugreifen. Dies ist der erste Schritt, bevor du die anderen API-Endpunkte nutzt.
Weitere Informationen zu detaillierten Schritten, einen Account zu registrieren, und wie die Authentifizierung funktioniert, findest du unter Authentifizierung.
RUM API
Die RUM API bietet Methoden zum Abruf von Metriken des Real User Monitoring (RUM) und von Website-Performance-Daten tatsächlicher Nutzerinteraktionen. Du kannst auf Details wie Seitenaufrufe, Ladezeiten, Download-Zeiten und andere Felder zugreifen, um die Metriken zum Nutzererlebnis und Browser-Performance-Daten zu verfolgen.
ScheduledReport API
Die ScheduledReport API bietet Methoden für die Erstellung, Aktualisierung, Löschung und Verwaltung der Bereitstellung von geplanten Monitoring-Berichten.
Du kannst automatisiert Berichte erzeugen und diese regelmäßig an die angegebenen Empfänger senden. Du kannst auf Details wie Berichtsnamen, Zeitpläne, Empfängerlisten usw. zugreifen.
SLA API
Die SLA API bietet Methoden für die Erstellung, Aktualisierung, Löschung und Verwaltung von Definitionen zu Service Level Agreements (SLA) deiner Monitoring-Einrichtung und ermöglicht den Abruf von SLA-Performance-Metriken.
Du kannst auf Details wie SLA-Namen, SLA-Ziele, Verfügbarkeitszusagen und andere Metriken zur Sicherstellung der Compliance, Verfügbarkeit und Performance in Bezug auf Geschäftsanforderungen zugreifen.
Weitere Informationen findest du unter SLA API.
Statistics API
Die Statistics API bietet Methoden zum Abruf von statistischen Daten aus deinen Uptrends Monitoring-Daten.
Du kannst auf statistische Verlaufs- und Echtzeitinformationen zugreifen, um Trends zu analysieren, Berichte zu erzeugen und Einblicke in die Service-Performance zu bestimmten Zeiträumen zu erhalten.
Du kannst auf Details wie Antwortzeiten, Verfügbarkeits- und Ausfallraten, Fehlerraten sowie Konnektivitäts-, Performance- und Verfügbarkeitsmetriken zugreifen.
Status API
Die Status API bietet Methoden für den Abruf von Echtzeit-Statusinformationen zu deinen Prüfobjekten. Du kannst die Verfügbarkeit und Performance deiner überwachten Ressourcen mit Details wie Fehlerlevel, Fehlerbeschreibung, Checkpoint-Standorte oder -Server und andere Felder abrufen.
Timezone API
Die Timezone API bietet Methoden zur Verwaltung von Zeitzoneneinstellungen, die steuern, wie Monitoring-Daten und Zeitstempel innerhalb deines Uptrends Account dargestellt werden. Es bestimmt das Format der Ortszeit, welches für das Reporting von Prüfobjektergebnissen, Alarmierungsbenachrichtigungen, geplanten Berichten und Dashboard-Anzeigen verwendet wird.
Du kannst auf Details wie Zeitzonenbeschreibung, Sommerzeitstatus und andere Felder zugreifen.
Weitere Informationen findest du unter Timezone API.
Vault API
Die Vault API bietet Methoden für die Erstellung, Aktualisierung, Löschung und Verwaltung von Vault Items und Bereichen und ihren zugehörigen Berechtigungen. Du kannst Anmeldedaten und sensible Informationen wie Vault Item-Typen, Benutzernamen, Passwörter und andere Felder sicher verwalten.
Weitere Informationen findest du unter Vault API.