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. Das Feld wird im Anfragetext ausgelassen, wenn POST verwendet wird. Es kann in PUT- oder PATCH-Anfragen benannt werden, muss dann aber der monitorGuid der URL oder des API-Aufrufs entsprechen.
`Name`	Der Name des Prüfobjekts. Stelle sicher, dass ein Name eingegeben ist. Er sollte auch nicht bereits im Account verwendet werden.
`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.
`GenerateAlert`	`True` oder `False`. Wenn dies auf `False` gesetzt ist, werden für dieses Prüfobjekt bei einem Fehler keine Warnmeldungen erzeugt.
`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 Page Checks, Real Browser Checks und Transaktionen ist der Mindestwert üblicherweise 5.
`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, RealBrowserCheck, Certificate, SFTP, MultiStepApi, IMAP`. Nicht alle Typen sind für jedes Abonnement verfügbar.
`MonitorMode`	Der Prüfobjektemodus, entweder `Development`, `Staging` oder `Production`. Weitere Informationen findest du in diesem Artikel über Prüfobjektmodi.
`Notes`	Deine Anmerkungen zu diesem Prüfobjekt.
`SelectedCheckpoints`	Die Checkpoint-Regionen oder einzelne Checkpoints, bei denen dieses Prüfobjekt ausgeführt wird.
`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 Informationen stehen in diesem Artikel bereit.
`IsLocked`	`True` oder `False` und ein „Nur lesen“-Feld. Es 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-Anfrage ist, kann nur der aktuelle Wert für dieses Prüfobjekt angegeben werden.
`NameForPhoneAlerts`	Der Wert des sprachausgabefreundlichen Prüfobjektnamens, falls zutreffend. 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 sie 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. In der folgenden Tabelle wird erklärt, welche Felder für welche Prüfobjekttypen geeignet sind. Die Bedeutung der typspezifischen Felder wird unten erläutert. Beachte, dass die Dokumentation ständig weiterentwickelt wird. Solltest du wegen eines Felds unsicher sein, sieh dir die entsprechenden Einstellungen in der Uptrends-Anwendung direkt an oder wende dich an unseren Support, um weitere Informationen zu erhalten.

	Https	Http	FPC	RBC	Transaction	MSA	Webservice Http	Webservice Https	DNS	SSL Certificate	SFTP	FTP	SMTP	POP3	IMAP	MS SQL server	MySQL	Ping	Connect
`MonitorGuid`	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•
`MonitorType`	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•		•
`Name`	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•
`CheckInterval`	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•
`Mode`	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•
`IsActive`	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•
`GenerateAlerts`	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•
`SelectedCheckpoints`	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•
`UsePrimaryCheckpointsOnly`	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•
`IsLocked`	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•
`IpVersion`	•	•					•	•	•	•	•	•	•	•	•	•	•	•	•
`NativeIPv6Only`	•	•					•	•	•	•	•	•	•	•	•	•	•	•	•
`NetworkAddress`											•	•	•	•	•	•	•	•	•
`Port`									•		•	•	•	•	•	•	•		•
`Url`	•	•	•	•			•	•		•
`UserAgent`	•	•	•	•	•		•	•
`Username`	•	•	•	•	•		•	•		•	•	•	•	•	•	•	•
`Password`	•	•	•	•	•		•	•		•	•	•	•	•	•	•	•
`Notes`	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•
`AlertOnLoadTimeLimit1`	•	•	•	•	•		•	•	•	•	•	•	•	•	•	•	•	•	•
`LoadTimeLimit1`	•	•	•	•	•		•	•	•	•	•	•	•	•	•	•	•	•	•
`AlertOnLoadTimeLimit2`	•	•	•	•	•		•	•	•	•	•	•	•	•	•	•	•	•	•
`LoadTimeLimit2`	•	•	•	•	•		•	•	•	•	•	•	•	•	•	•	•	•	•
`AlertOnMinimumBytes`	•	•	•	•			•	•
`MinimumBytes`	•	•	•	•			•	•
`CustomFields`	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•	•
`MatchPattern`	•	•	•	•			•	•
`TransactionStepDefinition`					•
`MsaSteps`						•
`PredefinedVariables`						•
`SelfServiceTransactionScript`					•
`CertificateName`										•
`CertificateOrganization`										•
`CertificateOrganizationalUnit`										•
`CertificateSerialNumber`										•
`CertificateFingerprint`										•
`CertificateIssuerName`										•
`CertificateIssuerCompanyName`										•
`CertificateIssuerOrganizationalUnit`										•
`CertificateExpirationWarningDays`										•
`CheckCertificateErrors`	•							•		•
`ImapSecureConnection`															•
`DatabaseName`																•	•
`DnsServer`									•
`DnsQuery`									•
`DnsTestValue`									•
`DnsExpectedResult`									•
`AlertOnMaximumBytes`			•
`MaximumBytes`			•
`AlertOnMaximumSize`			•
`ElementMaximumSize`			•
`IgnoreExternalElements`			•
`AlertOnPercentageFail`			•
`FailedObjectPercentage`			•
`DomainGroupGuid`			•
`HttpMethod`	•	•					•	•
`CheckHttpStatusCode`	•	•					•	•
`ExpectedHttpStatusCode`	•	•					•	•
`TlsVersion`	•	•					•	•
`RequestBody`	•	•					•	•
`BrowserType`			•	•	•
`BrowserWindowDimensions`			•	•	•
`AuthenticationType`	•	•	•	•	•		•	•		•
`RequestHeaders`	•	•	•	•	•		•	•
`ThrottlingOptions`			•	•	•
`BlockGoogleAnalytics`			•	•	•
`BlockUptrendsRum`			•	•	•
`BlockUrls`			•	•	•
`SftpAction`											•
`SftpActionPath`											•

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.
`NativeIPv6Only`	`True` oder `False`. Diese Einstellung ist nur vorhanden, wenn IpV6 im IpVersion-Feld gewählt wurde. Setze diesen Wert auf „True“, um das Prüfobjekt nur bei Checkpoint-Servern auszuführen, die eine native IPv6-Verbindung 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`	Eine Zeichenfolge die identifiziert, welcher HTTP-Client die HTTP-Anfrage sendet. Ein Browser sendet üblicherweise einen Wert, der den Browsertyp und die Version identifiziert, zum Beispiel könnte ein Chrome Browser senden: `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 jeden Text angeben, den Du magst, so lange wie der Webserver diesen als validen User Agent akzeptiert. Viele Webseiten und APIs kontrollieren dies nicht, aber manche nehmen es sehr genau. Für FPC, RBC und Transaktionsprüfobjekte gilt: wenn du diesen Wert leer lässt, wird der originale User Agent gesendet. Das bedeutet, der Wert für den User Agent kommt vom aktuellen Browser, der benutzt wird um das Prüfobjekt auszuführen.
`AuthenticationType`	Der Typ der HTTP-Authentifizierung, die benutzt werden soll, um Authentifizierungs-Daten zusammen mit der ausgehenden Anfrage zu versenden. Für HTTP(S) und Webservice HTTP(S) Prüfobjekte, für SSL-Zertifikat-Checks und für Authentifizierung innerhalb eines Multi-step-API- Schrittes, sind die folgenden Werte verfügbar: `None`, `Basic`, `NTLM`, `Digest`. Für RBC, FPC und Transaktionsprüfobjekte, wähle entweder `None` oder `Basic`. Dieses Feld kommt bei den anderen Prüfobjekttypen nicht zur Anwendung.
`Username`	Für Prüfobjekttypen, die HTTP Authentifizierung unterstützen (siehe das Feld `AuthenticationType)`, gib hier den Benutzernamen der entsprechenden Zugangsdaten an. Andere Prüfobjekttypen, inklusive SFTP, FTP, SMTP, POP3, IMAP, SQL Server und MySQL unterstützen Authentifizierung für das entsprechende Protokoll.
`Password`	Siehe das `Username` Feld. Gib hier das Passwort an.
`Notes`	Deine Anmerkungen zu diesem Prüfobjekt.