Hinweis: Ab 27. August 2025 werden einige Felder an den Endpunkten GET und POST /Monitor und GET, PUT und PATCH /Monitor/{monitorGuid} nicht länger verwendet. Weitere Informationen sind im API Changelog zu finden.
Überblick
Die Monitor API bietet eine Reihe an Endpunkten, mithilfe derer du deine Prüfobjekteinstellungen und -konfiguration verwalten kannst.
Einsatzbereiche
Verwende die Monitor API, um:
- Prüfobjekte und ihre Konfiguration zu verwalten – erstelle, aktualisiere, klone und lösche Prüfobjekte und greife auf ihre Einstellungen (Prüfobjektdefinition, Berechtigungen und Wartungszeiträume) zu.
- Wartungszeiträume einzurichten – plane und verwalte Wartungszeiträume, um Fehlalarme während geplanter Ausfallzeiten zu vermeiden.
- Prüfobjektdefinitionen gesammelt anzuzeigen – prüfe Echtzeit-Prüfobjektdefinitionen gleichzeitig zur Analyse und fürs Reporting.
Voraussetzungen
Bevor du die Monitor API nutzt, achte darauf, dass du über Folgendes verfügst:
- Uptrends API-Anmeldedaten
- Entsprechende Berechtigungen, um Prüfobjekte deines Uptrends Accounts zu verwalten.
- Ein grundlegendes Verständnis deiner Monitoring-Anforderungen und der Prüfobjekt einstellungen, die du konfigurieren musst.
Monitor API-Felder
Bei der Arbeit mit den Monitor API-Endpunkten enthält das Objekt Prüfobjekt verschiedene API-Felder, die je nach Prüfobjekttyp und der Konfiguration variieren können. Diese Felder sind MonitorGuid, MonitorType, GenerateAlert, IsActive usw.
Eine komplette Liste verfügbarer API-Felder findest du im Artikel Monitor API Felder.
Monitor API-Endpunkte
Die Monitor API stellt die folgenden Endpunkte zur Verwaltung deiner Prüfobjekte bereit:
Prüfobjekte verwalten
| Methode | Endpunkt | Beschreibung |
|---|---|---|
GET |
/Monitor |
Rufe eine Liste aller Prüfobjekte und ihrer Konfiguration ab, mit Optionen, nach bestimmten Feldern zu filtern. |
POST |
/Monitor |
Erstellen ein neues Prüfobjekt mit der gegebenen Konfiguration. |
GET |
/Monitor/{monitorGuid} |
Rufe ein Prüfobjekt und seine Konfiguration über die Prüfobjekt-ID ab. |
PATCH |
/Monitor/{monitorGuid} |
Aktualisiere ausgewählte Felder eines Prüfobjekts. |
PUT |
/Monitor/{monitorGuid} |
Aktualisiere alle Felder eines Prüfobjekts. |
DELETE |
/Monitor/{monitorGuid} |
Entferne das angegebene Prüfobjekt aus deinem Account. |
POST |
/Monitor/{monitorGuid}/Clone |
Erstelle ein Prüfobjekt-Duplikat mit identischer Konfiguration (URL, Überwachungsintervall, Alarmierungseinstellungen usw.), aber mit einer neuen einzigartigen Prüfobjekt-ID. Das geklonte Prüfobjekt ist zunächst auf inaktiv gesetzt, sodass du seine Konfiguration vor Aktivierung ändern kannst. |
Prüfobjekte nach Prüfobjektgruppe verwalten
| Methode | Endpunkt | Beschreibung |
|---|---|---|
GET |
/Monitor/{monitorGuid}/MonitorGroup/ |
Rufe die GUIDs von Prüfobjektgruppen ab, bei denen das angegebene Prüfobjekt Mitglied ist. |
GET |
/Monitor/MonitorGroup/{monitorGroupGuid} |
Rufe Prüfobjekte und ihre Konfigurationen auf Basis der angegebenen Prüfobjektgruppen-GUID ab, mit optionalen Feldfiltern. |
POST |
/Monitor/MonitorGroup/{monitorGroupGuid} |
Erstelle ein Prüfobjekt mit einer angegebenen Konfiguration und füge es der angegebenen Prüfobjektgruppe hinzu. |
Wartungszeiträume von Prüfobjekten verwalten
| Methode | Endpunkt | Beschreibung |
|---|---|---|
GET |
/Monitor/{monitorGuid}/MaintenancePeriod |
Rufe alle geplanten Wartungszeiträume für das angegebene Prüfobjekt ab.
|
PUT |
/Monitor/{monitorGuid}/MaintenancePeriod/{maintenancePeriodId} |
Aktualisiere die geplanten Wartungszeiträume für das angegebene Prüfobjekt.
|
POST |
/Monitor/{monitorGuid}/MaintenancePeriod |
Plane einen neuen Wartungszeitraum für das angegebene Prüfobjekt.
|
DELETE |
/Monitor/{monitorGuid}/MaintenancePeriod/{maintenancePeriodId} |
Lösche einen geplanten Wartungszeitraum aus dem angegebenen Prüfobjekt.
|
POST |
/Monitor/{monitorGuid}/MaintenancePeriod/CleanUp/{beforeDate} |
Entferne alle einmaligen Wartungszeiträume vor dem angegebenen Datum aus dem angegebenen Prüfobjekt.
|
Prüfobjektberechtigungen verwalten
| Methode | Endpunkt | Beschreibung |
|---|---|---|
GET |
/Monitor/{monitorGuid}/Authorizations |
Rufe alle Prüfobjektberechtigungen zu dem angegebenen Prüfobjekt ab.
|
POST |
/Monitor/{monitorGuid}/Authorizations |
Füge Prüfobjektberechtigungen zum angegebenen Prüfobjekt hinzu. Gewähren einer Berechtigung fügt automatisch alle erforderlichen Berechtigungen für diese Berechtigung hinzu.
|
DELETE |
/Monitor/{monitorGuid}/Authorizations/{authorizationGuid} |
Entferne die Prüfobjektberechtigung zu dem angegebenen Prüfobjekt.
|
Mehr Informationen zu den Abfrage- und Antwortformaten und zu interaktiven API-Tests findest du in der Uptrends Monitor API-Dokumentation.
Fehlerbehebung
Dieser Abschnitt behandelt übliche HTTP-Fehler und Schritte zur Fehlerbehebung bei der Monitor API.
Übliche Fehler
Übliche HTTP-Statuscodes und ihre Beschreibungen:
| Statuscode | Beschreibung |
|---|---|
| 200 | OK – Abfrage erfolgreich. |
| 204 | Kein Inhalt – die Abfrage wurde erfolgreich gesendet und es wurde keine Antwort zurückgegeben. Dies ist der Fall bei DELETE-, PUT-, PATCH- und POST-Abfragen. |
| 400 | Ungültige Abfrage – ungültige Abfrageparameter oder fehlende erforderliche Felder. |
| 401 | Nicht autorisiert – ungültige oder fehlende Authentifizierungsdaten. |
| 403 | Verboten – Erlaubnis verweigert. |
| 404 | Nicht gefunden – die angegebene GUID existiert nicht. |
| 500 | Interner Serverfehler – ein serverseitiger Fehler ist aufgetreten. |
Leitfaden zur allgemeinen Fehlerbehebung
Stelle sicher, dass:
- du immer deine Abfragedaten validierst, bevor du einen API-Aufruf sendest.
- du die entsprechenden HTTP-Methoden für jede Operation verwendest.
Solltest du weitere Hilfe benötigen, wende dich bitte an unser Support-Team.
Weitere Artikel
Weitere Informationen findest du in den folgenden Artikeln:
- Uptrends Monitor API-Dokumentation – eine interaktive API-Dokumentation mit detaillierten Endpunktspezifikationen.
- Monitor API Felder – eine komplette Liste verfügbarer Monitor API-Felder.
- MonitorCheck API – gibt detaillierte Informationen zu den einzelnen Überwachungen der Prüfobjekte aus.
- MonitorGroup API – gibt detaillierte Informationen zu den einzelnen Prüfobjektgruppen aus.
- API-Changelog – mit den neuesten API-Nachrichten und Hinweisen zu nicht fortgeführten Versionen und Endpunkten.