Monitor API velden

In dit artikel worden de API-velden beschreven die relevant zijn voor het werken met de Monitor API.

De definitie van een Monitor-object bevat veel velden. Sommige velden zijn van toepassing op alle controleregels (bijvoorbeeld MonitorGuid, Name, CheckInterval enzovoort). Echter, aangezien verschillende typen controleregels verschillende instellingen vereisen, zijn veel velden alleen relevant voor specifieke controleregeltypen.

Algemene controleregelvelden

Veldnaam	Beschrijving
`MonitorGuid`	De unieke ID van de controleregel. Deze waarde wordt geretourneerd wanneer u een bestaande controleregel ophaalt met GET of wanneer u een nieuwe creëert met POST. Dit veld moet in uw request body worden weggelaten als u POST gebruikt. Het kan worden gespecificeerd in PUT- of PATCH-requests, maar moet overeenkomen met de monitorGuid die is gespecificeerd in de URL van uw API call.
`Name`	De naam van de controleregel. Let erop dat u een naam gebruikt die niet leeg is en niet al bestaat in uw account.
`IsActive`	`True` of `False`. Geeft aan of de controleregel actief wordt uitgevoerd in de account. De waarde kan niet worden ingesteld op `True` als `MonitorMode` is ingesteld op `Development`.
`GenerateAlert`	`True` of `False`. Wanneer ingesteld op `False`, worden er geen alerts gegenereerd voor deze controleregel in geval van een fout (error).
`CheckInterval`	Numerieke waarde voor het tijdsinterval tussen afzonderlijke controles, in minuten. De maximumwaarde is 240 (4 uur). De minimumwaarde is afhankelijk van het type controleregel. Voor Full page checks en Transacties is het minimum meestal 5.
`MonitorType`	Het controleregeltype. Nadat een controleregel is gecreëerd, mag het type niet worden veranderd. Mogelijke waarden zijn `Http, Https, Connect, Ping, POP3, SMTP, FTP, MySQL, MSSQL, WebserviceHttp, WebserviceHttps, Transaction, DNS, FullPageCheck, RealBrowserCheck, Certificate, SFTP, MultiStepApi, IMAP`. Misschien zijn niet alle typen beschikbaar voor u: dit is afhankelijk van uw tariefstructuur.
`MonitorMode`	De controleregelmodus, hetzij `Development`, `Staging` of `Production`. Zie dit artikel voor meer informatie.
`Notes`	Uw notities voor deze controleregel.
`SelectedCheckpoints`	De controlestationregio’s of individuele controlestations waar deze controleregel zal worden uitgevoerd
`UsePrimaryCheckpointsOnly`	`True` or `False`. De aanbevolen waarde is `True`. Stel dit alleen in op `False` als u zeker weet dat u uw controleregel op niet-primaire controlestations wilt uitvoeren. Zie dit artikel voor meer informatie.
`IsLocked`	`True` or `False`, en een alleen-lezenveld. Het specificeert of de controleregel momenteel is locked for editing (vergrendeld voor bewerking). Dit gebeurt als het Support team uw controleregel aan het beoordelen is. Als u dit veld in een POST-request opneemt, moet u de waarde `False` specificeren. Als u dit veld opneemt in een PUT- of PATCH-request, kunt u alleen de huidige waarde voor deze controleregel specificeren
`NameForPhoneAlerts`	De waarde voor de spraakvriendelijke controleregelnaam, indien van toepassing. Dit is de controleregelnaam die we zullen gebruiken bij tekst-naar-spraak telefoonalerts, mits de optie ‘Gebruik alternatieve controleregelnamen’ is ingeschakeld in de integratie van de telefoonalert. Zo niet, dan is dit veld niet beschikbaar via de API.

Velden voor specifieke controleregeltypen

Omdat elk controleregeltype een ander doel heeft, behoeven verschillende typen controleregels hun eigen instellingen. In de volgende tabel wordt uitgelegd welke velden geschikt zijn voor welke controleregeltypen. De betekenis van de typespecifieke velden wordt hieronder uitgelegd. Houd er rekening mee dat de documentatie voor deze velden steeds toeneemt. Als u niet zeker bent van een bepaald veld, bekijk dan de bijbehorende instellingen in de Uptrends-applicatie zelf of neem contact op met Support voor meer informatie.

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

Field name	Description
`IpVersion`	`IpV4` of `IpV6`. Geeft aan welke IP-versie moet worden gebruikt om verbinding te maken met de server of het netwerkadres dat u opgeeft. Als u IPv6 kiest, wordt de controleregel alleen uitgevoerd op controlestationlocaties die IPv6 ondersteunen.
`NetworkAddress`	Het netwerkadres dat moet worden gebruikt om verbinding te maken met de server of dienst die u wilt monitoren. Als u een hostnaam opgeeft (bijvoorbeeld server.your-domain.com), wordt die hostnaam resolved tijdens een controleregelcheck op de controlestationserver die de controle uitvoert, aan de hand van de DNS-instellingen die beschikbaar zijn op die locatie. U kunt ook een IPv4- of IPv6-adres opgeven. Wilt u een specifiek poortnummer opgeven (indien van toepassing), gebruik dan het veld Poort. Poortnummers mogen niet worden opgenomen in het veld NetworkAddress.
`Port`	Het TCP-poortnummer dat moet worden gebruikt om een verbinding tot stand te brengen met de hostnaam of het IP-adres dat u hebt gespecificeerd.
`Url`	De volledige URL van de juiste website, pagina of dienst die u wilt monitoren. De URL moet “http://” of “https://” bevatten. Voeg indien relevant ook een poortnummer toe als u een niet-standaard poortnummer gebruikt, bijvoorbeeld `https://your-domain.com:8080/your-page`. U kunt ook een vast IP-adres gebruiken als onderdeel van de URL in plaats van een hostnaam, als uw server luistert naar inkomende requests zonder hostnaam.
`UserAgent`	Een stringwaarde die identificeert welke HTTP-client de HTTP-request doet. Een browser verstuurt doorgaans een waarde die het browsertype en -versie identificeert. Een Chrome-browser bijvoorbeeld, kan `Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.79 Safari/537.36` sturen. U kunt elke gewenste tekst invullen, zolang uw webserver die als geldige user agent accepteert. Bij veel websites en API’s doet dit er niet toe, maar sommige zijn er heel kieskeurig in. Voor FPC- en Transactie-controleregels: als u deze waarde leeg laat, wordt de native user agent verzonden, d.w.z. de useragent-waarde die wordt geproduceerd door de feitelijke browser die wordt gebruikt om de controleregel uit te voeren.
`AuthenticationType`	Het type HTTP-authenticatie dat gebruikt moet worden om authenticatiegegevens samen met de uitgaande request te versturen. Voor HTTP(S)- en Webservice HTTP(S)-controleregels, voor SSL-certificaatcontroles en voor authenticatie binnen een Multi-step API-stap zijn de volgende waarden beschikbaar: `None`, `Basic`, `NTLM`, `Digest`. Kies voor FPC- en Transactie-controleregels `None` of `Basic`. Dit veld is niet van toepassing op andere controleregeltypen.
`Username`	Voor controleregeltypen die HTTP-authenticatie ondersteunen (zie het veld `AuthenticationType`), specificeert u hier de gebruikersnaam van de juiste inloggegevens. Andere controleregeltypen, waaronder SFTP, FTP, SMTP, POP3, IMAP, SQL Server en MySQL ondersteunen ook authenticatie voor het juiste protocol.
`Password`	Zie het veld `Username` Specificeer hier de bijbehorende wachtwoordwaarde.
`Notes`	Specificeer uw eigen aangepaste notities voor deze controleregel.