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.
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, Name, CheckInterval usw.). 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. Das Feld wird im Anfragetext ausgelassen, wenn POST verwendet wird. Es kann in PUT- oder PATCH-Abfragen benannt werden, muss dann aber der monitorGuid der URL oder des API-Aufrufs entsprechen. |
Name |
Der Name des Prüfobjekts. Dies sollte ein bedeutungsvoller Name sein, der nicht bereits im Account verwendet wird. |
MonitorType |
Der Prüfobjekttyp. Nachdem ein Prüfobjekt erstellt wurde, kann der Typ nicht mehr geändert werden. Mögliche Werte sind Http, Https, Connect, Ping, POP3, SMTP, FTP, MySQL, MSSQL, WebserviceHttp, WebserviceHttps, Transaction, DNS, FullPageCheck, Certificate, SFTP, MultiStepApi, IMAP und Postman. Beachte, dass die Verfügbarkeit von Prüfobjekttypen von deinem Abonnement abhängt. |
GenerateAlert |
True oder False. Wenn dies auf „False“ gesetzt ist, werden für dieses Prüfobjekt bei einem Fehler keine Warnmeldungen erzeugt. |
IsActive |
True oder False. Dies zeigt an, ob das Prüfobjekt im Account aktiv ist. Der Wert kann nicht True lauten, wenn der MonitorMode auf Development gesetzt wurde. |
IsLocked |
True oder False und ein „Nur lesen“-Feld. Dies gibt an, ob das Prüfobjekte für eine Bearbeitung gesperrt ist. Das ist der Fall, wenn das Support-Team dein Prüfobjekt testet. Wenn dieses Feld Teil einer POST-Anfrage ist, muss der Wert „False“ lauten. Wenn dieses Feld Teil einer PUT- oder PATCH-Abfrage ist, kann nur der aktuelle Wert für dieses Prüfobjekt angegeben werden. |
IsLocked |
True oder False und ein „Nur lesen“-Feld. Dies gibt an, ob das Prüfobjekte für eine Bearbeitung gesperrt ist. Das ist der Fall, wenn das Support-Team dein Prüfobjekt testet. Wenn dieses Feld Teil einer POST-Anfrage ist, muss der Wert „False“ lauten. Wenn dieses Feld Teil einer PUT- oder PATCH-Abfrage ist, kann nur der aktuelle Wert für dieses Prüfobjekt angegeben werden. |
Custom fields |
Bezieht sich auf benutzerdefinierte Daten in den allgemeinen Einstellungen des Prüfobjekts. |
SelectedCheckpoints |
Die Checkpoint-Regionen oder einzelne Checkpoints, bei denen dieses Prüfobjekt ausgeführt wird. |
CheckInterval |
Ein numerischer Wert für das Zeitintervall zwischen einzelnen Checks in Minuten. Der Höchstwert beträgt 240 (4 Stunden). Der Mindestwert hängt vom Prüfobjekttyp ab. Bei Full Pagechecks und Transaktionen ist der Mindestwert üblicherweise 5. |
MonitorMode |
Der Modus des Prüfobjekts, entweder
Development, Staging oder Production. Weitere Infos gibt es in diesem Artikel. |
Notes |
Deine Anmerkungen zu diesem Prüfobjekt. |
UsePrimaryCheckpointsOnly |
True oder False. Der empfohlene Wert ist „True“. Dies sollte nur auf „False“ gesetzt werden, wenn sicher ist, dass das Prüfobjekt bei nicht primären Checkpoints ausgeführt werden soll. Weitere Infos gibt es in diesem Artikel. |
NameForPhoneAlerts |
Der Wert eines aussprachefreundlichen Prüfobjektnamens, sofern erforderlich. Dieser Prüfobjektname wird bei der Text-to-Speech-Telefonalarmierung (Alerting by Phone) verwendet, vorausgesetzt, dass die Option „Nutze abweichende Überwachungsnamen“ in der Integration Telefonalarmierung aktiviert wurde. Ist dies nicht aktiviert, ist das Feld nicht über die API verfügbar.
|
Felder für besondere Prüfobjekttypen
Da jeder Prüfobjekttyp für einen bestimmten Zweck steht, erfordern unterschiedliche Prüfobjekttypen eigene Einstellungen. Die folgende Tabelle zeigt weitere verfügbare Felder für unterschiedliche Prüfobjekttypen. Beachte, dass die Dokumentation ständig weiterentwickelt wird. Solltest du bei einem bestimmten Feld Zweifel haben, überprüfe die entsprechenden Einstellungen in der Uptrends Anwendung selbst oder siehe in der Uptrends API v4 Dokumentation nach.
| Feldname | Beschreibung |
|---|---|
IpVersion |
IpV4 oder IpV6. Zeigt an, welche IP-Version verwendet werden sollte, um mit dem von dir angegebenen Server oder der Netzwerk-Adresse zu verbinden. Wird IPv6 gewählt, wird das Prüfobjekt nur an Checkpoint-Standorten ausgeführt, die IPv6 unterstützen. |
NetworkAddress |
Die Netzwerk-Adresse, die verwendet werden sollte, um mit dem Server oder dem Service zu verbinden, den du überwachen möchtest. Wenn ein Hostname (z. B. server.your-domain.com) angegeben wird, wird dieser Hostname während eines Prüfobjekt-Checks auf dem Checkpoint-Server aufgelöst, der den Check ausführt. Dabei werden die an dem Standort verfügbaren DNS-Einstellungen verwendet. Alternativ kannst du eine IPv4- oder IPv6-Adresse angeben. Einen bestimmten Port kannst du, sofern erforderlich, im Port-Feld eintragen. Port-Nummern sollten nicht im NetworkAddress-Feld angegeben werden. |
Port |
Die TCP-Portnummer sollte verwendet werden, um eine Verbindung mit dem angegebenen Hostnamen oder der IP-Adresse einzurichten. |
Url |
Die vollständige URL der Website, Seite oder des Service, die/den du überwachen möchtest. Die URL sollte „http://‟ oder „https://‟ enthalten. Gegebenenfalls solltest du die Port-Nummer angegeben, falls du nicht einen Standard-Port, z. B. https://your-domain.com:8080/your-page, verwendest. Du kannst auch eine feste IP-Adresse als Teil der URL statt eines Hostnamens verwenden, wenn dein Server eingehende Anfragen ohne Hostnamen verarbeitet. |
UserAgent |
Ein Zeichenkettenwert, der zeigt, welcher HTTP Client die HTTP-Abfrage sendet. Ein Browser sendet üblicherweise einen Wert, der den Browsertyp und die Version angibt. Ein Chrome-Browser sendet beispielsweise Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.79 Safari/537.36. Du kannst einen beliebigen Text eingeben, solang dein Webserver ihn als gültigen User Agent akzeptiert. Bei vielen Websites und APIs macht die Angabe keinen Unterschied, bei einigen ist eine korrekte Angabe jedoch wichtig. Bei FPC- und Transaktionsprüfobjekten: Bleibt dieser Wert leer, wird der native User Agent gesendet, d. h., der vom tatsächlichen, das Prüfobjekt ausführenden Browser erzeugte User Agent-Wert. |
AuthenticationType |
Der Typ der HTTP-Authentifizierung, der verwendet werden sollte, um Authentifizierungsdaten mit der ausgehenden Abfrage zu senden. Für HTTP(S)- und Webservice HTTP(S)-Prüfobjekte, für SSL-Zertifikatsprüfungen und für Authentifizierungen im Rahmen eines Multi-Step API-Schritts sind die folgenden Werte verfügbar: None, Basic, NTLM, Digest. Für FPC- und Transaktionsprüfobjekte wähle entweder None oder Basic. Dieses Feld gilt nicht für andere Prüfobjekttypen. |
Username |
Gib für Prüfobjekttypen, die eine HTTP-Authentifizierung (siehe Feld AuthenticationType) unterstützen, den Benutzernamen der entsprechenden Anmeldedaten hier an. Andere Prüfobjekttypen, darunter SFTP, FTP, SMTP, POP3, IMAP, SQL Server und MySQL, unterstützen ebenfalls eine Authentifizierung für das entsprechende Protokoll. |
Password |
Siehe Feld Username. Gib hier den entsprechenden Passwortwert ein. |
Notes |
Gib deine eigenen Anmerkungen des Prüfobjekts an. |