1. Support
  2. Base de connaissances
  3. API d'Uptrends
  4. Champs de l'API Monitor

Champs de l’API Monitor

Remarque : À compter du 27 août 2025, certains champs des endpoints GET et POST /Monitor et GET, PUT et PATCH /Monitor/{monitorGuid} seront retirés. Pour en savoir plus, vous pouvez consulter le Journal des modifications de l’API.

Cet article décrit les champs permettant d’utiliser l' API Monitor.

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, comme les différents types de moniteurs nécessitent différents paramètres, de nombreux champs s’appliquent uniquement à certains types de moniteurs.

Champs applicables à tous les moniteurs

Nom du champ Description
MonitorGuid Il s’agit de l’identifiant unique du moniteur. Cette valeur est renvoyée lorsque vous récupérez un moniteur existant au moyen de la requête GET ou lorsque vous en créez un nouveau au moyen de la requête POST. Ce champ doit être omis dans le corps de votre requête lorsque vous utilisez la requête POST. Il doit être spécifié dans les requêtes PUT ou PATCH, et correspondre à la valeur monitorGuid spécifiée dans l’URL de votre appel d’API.
Name Il s’agit du nom du moniteur. Assurez-vous que le nom n’est pas vide et qu’il n’existe pas déjà dans votre compte.
MonitorType Il s’agit du type de moniteur. Une fois le moniteur créé, le type de moniteur ne doit pas changer. Les valeurs possibles sont Http, Https, Connect, Ping, POP3, SMTP, FTP, MySQL, MSSQL, WebserviceHttp, WebserviceHttps, Transaction, DNS, FullPageCheck, Certificate, SFTP, MultiStepApi, IMAP et Postman. Notez que la disponibilité des types de moniteur dépend de votre forfait.
GenerateAlert Il s’agit de valeurs True ou False. Si la valeur définie est “False”, aucune alerte n’est générée pour ce moniteur en cas d’erreur.
IsActive Il s’agit de valeurs True ou False. Cette valeur indique si le moniteur est actif dans votre compte. La valeur ne peut pas être définie sur True lorsque le MonitorMode est Development.
IsLocked Il s’agit de valeurs True ou False, et d’un champ en lecture seule. Ce champ indique si le moniteur est *verrouillé pour cause de modification *. Cette valeur s’affiche lorsque l’équipe de support vérifie votre moniteur. Si vous incluez ce champ dans une requête POST, vous devez préciser la valeur “False”. Si vous incluez ce champ dans une requête PUT ou PATCH, vous pouvez uniquement préciser la valeur actuelle du moniteur.
Custom fields Ce champ désigne les données personnalisées définies dans les paramètres principaux de votre moniteur.
SelectedCheckpoints Il s’agit des régions de checkpoints ou des checkpoints individuels sur lesquels ce moniteur sera exécuté.
CheckInterval Il s’agit d’une valeur numérique correspondant à l’intervalle de temps entre les vérifications individuelles, en minutes. La valeur maximale est de 240 (soit 4 heures). La valeur minimale dépend du type de moniteur. Pour les moniteurs Full Page Check et les moniteurs de transactions, le minimum est généralement fixé à 5.
MonitorMode Il s’agit du mode de moniteur, soit Development, Staging ou Production. Consultez cet article pour en savoir plus.
Notes Il s’agit de vos notes concernant ce moniteur.
UsePrimaryCheckpointsOnly Il s’agit de valeurs True ou False. La valeur recommandée est “True”. Appliquez la valeur “False” seulement si vous êtes sûr de vouloir exécuter votre moniteur sur des checkpoints non primaires. Lisez cet article pour en savoir plus.
NameForPhoneAlerts Il s’agit de la valeur applicable du nom de moniteur compatible avec la synthèse vocale, s’il existe. C’est le nom du moniteur tel que que nous l’utilisons dans les alertes téléphoniques reposant sur la synthèse vocale. Pour cela, l’option “Utiliser des noms de moniteur alternatif” doit avoir été activée dans l’intégration des alertes par téléphone. Dans le cas contraire, ce champ n’est pas récupérable par l’API.

Champs spécifiques à des types de moniteur

Dans la mesure où chaque type de moniteur poursuit un objectif différent, les différents types de moniteur ont leurs propres paramètres. Le tableau suivant montre les autres champs disponibles pour les différents types de moniteur. La documentation relative à ces champs est en cours de développement. Si vous avez des doutes sur un champ donné, veuillez vérifier les paramètres correspondants dans l’application d’Uptrends ou reportez-vous à la documentation de l’API v4 d’Uptrends.

Nom du champ Description
IpVersion IpV4 ou IpV6. Indique quelle version IP doit être utilisée pour se connecter au serveur ou à l’adresse réseau précisé. Si vous choisissez IPv6, le moniteur pourra uniquement s’exécuter sur les emplacements de checkpoint compatibles avec IPv6.
NetworkAddress Il s’agit de l’adresse réseau à utiliser pour se connecter au serveur ou au service que vous souhaitez surveiller. Lorsque vous précisez un nom d’hôte (par exemple, server.your-domain.com), ce nom d’hôte sera résolu lors d’une vérification de moniteur exécutée sur le serveur de checkpoint 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 souhaitez indiquer un numéro de port spécifique (le cas échéant), veuillez utiliser le champ Port. Les numéros de port ne doivent pas être inclus dans le champ NetworkAddress.
Port Il s’agit du numéro de port TCP à utiliser pour se connecter au nom d’hôte ou à l’adresse IP spécifiée.
Url Il s’agit de l’URL complète du site web, de la page web ou du service que vous souhaitez surveiller. L’URL doit inclure “http://” ou “https://”. Le cas échéant, veuillez aussi inclure un numéro de port si vous utilisez un port non standard, par exemple  https://your-domain.com:8080/your-page. Si votre serveur accepte les requêtes entrantes sans nom d’hôte, vous pouvez également utiliser une adresse IP fixe dans l’URL à la place d’un nom d’hôte.
UserAgent Il s’agit d’une chaîne de caractères qui identifie le client HTTP effectuant la requête HTTP. Le navigateur envoie généralement une valeur qui indique le type et la version du navigateur. 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 saisir n’importe quel texte, tant que votre serveur web l’accepte comme un agent utilisateur valide. C’est le cas de nombreux sites web et API, tandis que d’autres sont très sensibles au format de l’agent utilisateur. Pour les moniteurs FPC et les moniteurs de transactions : si vous laissez ce champ vide, l’agent utilisateur natif sera envoyé, c’est-à-dire la valeur générée par le navigateur réel utilisé pour exécuter le moniteur.
AuthenticationType Il s’agit du type d’authentification HTTP à utiliser pour envoyer les 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-étapes, les valeurs suivantes sont disponibles : None, Basic, NTLM et Digest. Pour les moniteurs FPC et les moniteurs de transactions, vous avez le choix entre None et Basic. Ce champ ne s’applique à aucun autre type de moniteur.
Username Indique le nom d’utilisateur pour les types de moniteur qui prennent en charge l’authentification HTTP (voir le champ AuthenticationType). D’autres types de moniteurs, tels que SFTP, FTP, SMTP, POP3, IMAP, SQL Server et MySQL prennent également en charge l’authentification selon le protocole concerné.
Password Voir le champ Username. Ce champ précise le mot de passe correspondant.
Notes Il s’agit de vos notes concernant ce moniteur.
En utilisant ce site, vous consentez à l’utilisation de cookies conformément à notre Politique de cookies.