API d'Uptrends | Uptrends

L’API Uptrends vous permet de travailler de manière automatisée avec votre compte Uptrends : vous pouvez créer des scripts qui modifient la configuration de votre surveillance, ou accéder aux données de disponibilité et de performance pour effectuer vos propres calculs.

Nous avons actuellement deux versions d’API :

Version 4 est la version de l’API recommandée. Lorsque vous commencez à travailler avec l’API, c’est la version à utiliser. La version 4 offre beaucoup plus de fonctionnalités que la version 3.
Version 3 est une ancienne version et a beaucoup moins d’options que la version 4 de l’API. Vous ne devriez l’utiliser que lorsque vous l’avez déjà implémenté et que vous comptez dessus pour son fonctionnement.

La version 3 est toujours prise en charge, mais ce n’est pas l’option préférée et deviendra obsolète au fil du temps. Les versions 3 et 4 coexisteront pendant un certain temps. La fin de vie de la version 3 sera annoncée bien à l’avance, vous laissant suffisamment de temps pour préparer le passage à la version 4.

Les deux versions sont des API REST qui nécessitent une connexion à l’aide d’une authentification de base avec en-tête HTTP. Les informations d’identification utilisées pour l’authentification sont différentes pour les versions, voir la documentation correspondante pour plus d’informations.

Pour plus d’informations sur l’utilisation de l’API, consultez les articles de la base de connaissances et la spécification de l’API, comme indiqué ci-dessous.

Informations générales sur l’API (versions 3 et 4)

Utilisation de cURL pour les appels API

Utilisation de Powershell pour les appels API

Liste blanche des adresses IP

Spécification des régions pour les points de contrôle

API Version 4

Authentification et création d’un compte API

Spécification OpenAPI (environnement Swagger)

Documentation de l’API

Méthodes API pour les moniteurs

Les champs de l’API moniteur

API pour les définitions d’alerte

API pour le coffre-fort

API Maintenanceperiods

API Version 3

Documentation de l’API

Pages de cette section

Accès à l'API Uptrends API avec PowerShell
Apprenez comment configurer une connexion à l’API Uptrends avec PowerShell.
Accès à l'API Uptrends avec cURL
Apprenez comment utiliser cURL pour accéder à l’API Uptrends, recevoir les données de monitoring et commander la supervision.
Adresses IP à ajouter sur liste blanche
Tous les services d’Uptrends, y compris le portail des applications, les sites www, l’API Uptrends, Infra et Uptrends Real User Monitoring, et tous les autres services liés à Uptrends fonctionnent à partir de plusieurs emplacements avec plusieurs adresses IP.
API de définition d'alerte
À l’aide de l’API de définition d’alerte, vous pouvez gérer les paramètres d’une définition d’alerte spécifique. Une définition d’alerte est utilisée pour définir comment et à qui envoyer une alerte. Par exemple, vous pouvez définir une alerte qui est générée lorsqu’une erreur se produit pendant plus de 5 minutes, et choisir les utilisateurs à notifier par e-mail et SMS. L’API de définition d’alerte ne prend actuellement en charge que l’activation et la désactivation d’une définition d’alerte.
API du Coffre-fort
Le coffre-fort est utilisé pour stocker des données réutilisables, souvent des données sensibles telles que des certificats, des clés publiques et des combinaisons nom d’utilisateur/mot de passe. Chaque entrée dans le coffre-fort est appelé un élément de coffre-fort, et les éléments de coffre-fort sont organisés en Sections de coffre-fort. L’organisation d’éléments dans des sections différentes est également utile pour restreindre l’accès à des opérateurs et des groupes particuliers. Cet article décrit les méthodes API disponibles pour la gestion des éléments, des sections et des autorisations de section pour les coffre-forts.
API du groupe d'opérateurs
Méthodes d’API disponibles pour manipuler des groupes d’opérateurs.
API Moniteur
Les endpoints (points d’entrée) qui font partie de l’API Moniteur vous aident à gérer vos paramètres de moniteur dans Uptrends. Les moniteurs dans Uptrends définissent ce qui doit être surveillé. En règle générale, un moniteur vérifie une seule page web, ou une séquence d’appels d’API, ou un chemin de clic d’utilisateur final dans un site web. L’API Moniteur a plusieurs endpoints qui vous permettent de créer, modifier, cloner ou supprimer des définitions de moniteur.
API version 4
Notre 4e version de l’API Uptrends vous permet de gérer et de modifier les moniteurs API multi-étapes et les moniteurs de transaction. Dans notre nouvelle version, l’offre API va continuer à s’étoffer.
Authentification (version 4)
Comment enregistrer votre compte API et comment fonctionne l’authentification
Choisir la bonne version de l'API
Quelle version API est la mieux adaptée à vos besoins : Version 3, Version 4, ou les deux ?
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.
MonitorCheck API
Les données de vérification du moniteur peuvent être récupérées depuis les endpoints de l’API MonitorCheck qui font partie de API v4. Les Monitor checks (vérifications de moniteur) sont les mesures individuelles que nous recueillons pour chaque moniteur, et le MonitorCheck API donne accès à ces données brutes. Une fois téléchargées, ces données peuvent être stockées dans une base de données soit pour une analyse hors ligne, soit pour un audit ou à des fins de sauvegarde.
MonitorGroup API
Cette page décrit les méthodes d’API disponibles pour manipuler des groupes de moniteurs.
Operator API
Les méthodes d’API disponibles pour manipuler les opérateurs.
Périodes de maintenance dans l'API
Il existe un ensemble spécifique de méthodes API permettant de manipuler les périodes de maintenance d’un moniteur ou de tous les moniteurs d’un groupe de moniteurs. Description de l’objet Période de Maintenance L’objet suivant MaintenancePeriod est utilisé dans les méthodes API décrites ci-dessous : Nom Description Type données Id L’identifiant unique pour cette période de maintenance Integer ScheduleMode OneTime, Daily, Weekly or Monthly Enum StartDateTime Une date et une heure de début (applicable uniquement à une période planifiée ponctuelle) DateTime EndDateTime La date et l’heure de fin d’une période de maintenance planifiée ponctuelle DateTime StartTime L’heure de début (“HH:mm”, notation 24 heures) pour une période de maintenance récurrente (Daily, Weekly ou Monthly) String (“HH:mm”) EndTime L’heure de fin (“HH:mm”, notation 24 heures) pour une période de maintenance récurrente (Daily, Weekly ou Monthly) String (“HH:mm”) WeekDay Le jour de la semaine pour une période de maintenance hebdomadaire (Sunday/Monday/[…]/Saturday) Enum MonthDay Le numéro du jour pour une période de maintenance mensuelle Int (1-31) MaintenanceType DisableMonitoring (pour désactiver complètement le moniteur) ou DisableNotifications (la surveillance aura toujours lieu, mais les notifications ne seront pas envoyées) Enum Quand une période de maintenance est retournée via l’API, toutes les propriétés seront présentes, mais en fonction de la ScheduleMode, certains champs liés aux dates ou heures de début et de fin ne seront pas utilisés.
Spécification des régions pour les points de contrôle
Comment spécifier vos points de contrôle lorsque votre compte vous limite à des régions entières.
Uptrends API v3
Utilisez la version 3 de l’API Uptrends pour modifier les moniteurs (sauf pour l’API multi-étapes et les moniteurs de transaction), pour obtenir des mises à jour de statut et pour récupérer les données des points de contrôle.