1. Support
  2. Base de connaissances
  3. API d'Uptrends
  4. Les champs de l'API moniteur

Les champs de l’API moniteur

Cet article décrit les champs d’API à utiliser avec l’API Moniteur.

La définition d’un objet Moniteur contient de nombreux champs. Certains champs s’appliquent à tous les moniteurs (par exemple, MonitorGuid, Name, CheckInterval, etc.). Cependant, étant donné que différents types de moniteurs nécessitent des paramètres différents, de nombreux champs ne sont pertinents que pour certains types de moniteurs spécifiques.

Champs de moniteur génériques

Nom de champ Description
MonitorGuid ID unique du moniteur. Cette valeur est renvoyée lorsque vous récupérez un moniteur existant à l’aide de GET ou lorsque vous en créez un nouveau à l’aide de POST. Ce champ doit être omis dans votre corps de requête lorsque vous utilisez POST. Il peut être spécifié dans les requêtes PUT ou PATCH, mais il doit correspondre au monitorGuid spécifié dans l’URL de votre appel API.
Name Le nom du moniteur. Faites attention à utiliser un nom qui n’est pas vide et qui n’existe pas déjà dans votre compte.
IsActive True ou False. Indique si le moniteur s’exécute (est actif) dans le compte. Ne peut pas prendre la valeur de True lorsque MonitorMode est défini sur Development.
GenerateAlert True ou False. Si false, aucune alerte ne sera générée pour ce moniteur en cas d’erreur.
CheckInterval Valeur numérique de l’intervalle de temps entre les vérifications individuelles, en minutes. La valeur maximale est de 240 (4 heures). La valeur minimale dépend du type de moniteur. Pour les Full Page Checks et les transactions, le minimum est généralement de 5.
MonitorType Le type de moniteur. Une fois le moniteur créé, le type ne peut plus être modifié. Les valeurs possibles sont Http, Https, Connect, Ping, POP3, SMTP, FTP, MySQL, MSSQL, WebserviceHttp, WebserviceHttps, Transaction, DNS, FullPageCheck, RealBrowserCheck, Certificate, SFTP, MultiStepApi, IMAP. Vous n’avez peut-être pas accès à tous les types : cela dépend de votre plan tarifaire.
MonitorMode Le mode moniteur, soit Development, Staging or Production. Consultez cet article pour plus d’informations.
Notes YVos notes pour ce moniteur.
SelectedCheckpoints Les régions de points de contrôle ou les points de contrôle individuels où ce moniteur fonctionnera.
UsePrimaryCheckpointsOnly True ur False. La valeur recommandée est True. Ne mettez False que si vous êtes sûr de vouloir exécuter votre moniteur seulement sur des points de contrôle non principaux. Consultez cet article pour plus d’informations
IsLocked True ou False. Champ en lecture seule. Indique si le moniteur est actuellement verrouillé pour l’édition. Cela se produit si l’équipe de support est en train d’examiner votre moniteur. Si vous incluez ce champ dans une requête POST, vous devez spécifier la valeur False. Si vous incluez ce champ dans une requête PUT ou PATCH, vous devez spécifier la valeur courante pour ce moniteur.
NameForPhoneAlerts La valeur pour le nom qui facilitent la synthèse vocale , le cas échéant. C’est le nom du moniteur que nous utiliserons dans les alertes téléphoniques de synthèse vocale, à condition que l’option « Utiliser des noms de moniteur alternatifs » ait été activée dans l’intégration des alertes téléphoniques. Si ce n’est pas le cas, ce champ ne sera pas disponible via l’API.

Les champs pour des types de moniteur spécifiques

Comme chaque type de moniteur a un objectif différent, il nécessite ses propres paramètres. Le tableau suivant explique quels champs sont requis par quels types de moniteur et une description de chaque champ spécifique au type est donnée. Ces champs et leur documentation sont en pleine évolution (augmentation) ! Si vous avez un doute sur un champ particulier, consultez les paramètres correspondants dans l’application Uptrends, ou contactez l’assistance pour obtenir plus d’informations.

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 • • • • • • • • • • • • • •
Nom de champ Description
IpVersion IpV4 ur IpV6. Indique la version IP à utiliser pour se connecter au serveur ou à l’adresse réseau que vous spécifiez. Si vous choisissez IPv6, le moniteur ne sera exécuté que sur les emplacements de points de contrôle qui prennent en charge IPv6.
NetworkAddress L’adresse réseau à utiliser pour se connecter au serveur ou au service que vous souhaitez surveiller. Lorsque vous spécifiez un nom d’hôte (par exemple, server.your-domain.com), ce nom d’hôte sera résolu lors d’une vérification du moniteur sur le serveur de point de contrôle qui effectue la vérification, en utilisant les paramètres DNS disponibles à cet emplacement. Vous pouvez également spécifier une adresse IPv4 ou IPv6. Si vous devez spécifier un numéro de port (le cas échéant), utilisez également le champ Port. Les numéros de port ne doivent pas être inclus dans le champ NetworkAddress.
Port Le numéro de port TCP à utiliser pour établir une connexion avec le nom d’hôte ou l’adresse IP que vous avez spécifié.
Url L’URL complète du site web, de la page ou du service que vous souhaitez surveiller. L’URL doit inclure “http://” ou “https://”. Le cas échéant, pensez à inclure également un numéro de port si vous utilisez un numéro de port autre que celui par défaut, par exemple https://your-domain.com:8080/your-page. Vous pouvez également utiliser une adresse IP fixe dans l’URL au lieu d’un nom d’hôte, si votre serveur prend en charge les requêtes entrantes sans nom d’hôte.
UserAgent Une valeur de chaîne qui identifie le client HTTP qui effectue la requête HTTP. Un navigateur envoie généralement une valeur qui identifie son type et sa version. Par exemple, un navigateur Chrome peut envoyer Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.79 Safari/537.36. Vous pouvez y mettre le texte que vous voulez, pourvu que votre serveur web l’accepte comme agent utilisateur valide. De nombreux sites web et API l’ignorent, mais certains y sont très attentifs. Pour les moniteurs FPC et transaction : si vous laissez cette valeur vide, l’agent utilisateur natif sera envoyé, à savoir la valeur UserAgent produite par le navigateur réel utilisé pour exécuter le moniteur.
AuthenticationType Le type d’authentification HTTP à utiliser pour envoyer des données d’authentification avec la requête sortante. Pour les moniteurs HTTP(S) et Webservice HTTP(S), pour les vérifications de certificats SSL et pour l’authentification dans une étape d’API multi-étape, les valeurs suivantes sont disponibles : None, Basic, NTLM, Digest. Pour les moniteurs FPC et transaction, choisissez soit. Ce champ ne s’applique à aucun autre type de moniteur.
Username Pour les types de moniteur qui prennent en charge l’authentification HTTP (voir le champ AuthenticationType field), indiquez ici le nom d’utilisateur. D’autres types de moniteurs, notamment SFTP, FTP, SMTP, POP3, IMAP, SQL Server et MySQL prennent également en charge l’authentification pour le protocole associé.
Password Voir le champ Username field. Indiquez ici la valeur du mot de passe correspondant.
Notes Rajoutez vos notes personnalisées pour ce moniteur.
En utilisant ce site, vous consentez à l’utilisation de cookies conformément à notre Politique de cookies.