La version 4 de l’API d’Uptrends fournit un ensemble complet d’endpoints qui vous permettent d’interagir avec l’application web d’Uptrends au moyen d’appels d’API. Vous pouvez utiliser l’API pour :
- Obtenir en temps réel des données de surveillance qui vous permettent de suivre la performance de votre site web et de vos services web.
- Récupérer des métriques de performance, des statistiques sur la disponibilité et des données historiques utiles pour vos analyses et vos rapports.
- Gérer les alertes, les paramètres de compte, les autorisations des utilisateurs et les configurations des moniteurs.
- Créer des scripts pour créer, modifier et supprimer des moniteurs, et gérer les configurations des moniteurs.
Pour connaître les derniers changements apportés à l’API et ses nouvelles fonctionnalités, vous pouvez consulter le Journal des modifications de l’API.
Accès à l’API
Pour pouvoir consulter et utiliser la version 4 de l’API d’Uptrends, vous devez d’abord créer un compte API. Une fois votre compte créé, tous les endpoints de l’API d’Uptrends sont accessibles dans la documentation de l’API v4 d’Uptrends. Cette documentation interactive décrit toutes les méthodes d’API en détail et fournit un environnement de test où vous pouvez essayer et exécuter directement les appels d’API.
Vous pouvez aussi utiliser notre spécification Swagger avec Swagger Codegen pour générer du code client et intégrer l’API d’Uptrends dans vos scripts ou applications. Pour en savoir plus sur Swagger et ses outils, vous pouvez consulter le site web Swagger.io.
Endpoints d’API
Actuellement, les endpoints d’API suivants sont disponibles :
API Account
La commande d’API Account fournit des méthodes pour créer, modifier, supprimer et gérer les informations relatives à votre compte et à votre abonnement. Elle vous permet d’accéder aux données relatives à votre compte, notamment les informations de facturation et les statistiques d’usage, qui vous sont utiles pour suivre votre abonnement Uptrends et la consommation des ressources.
Vous pouvez obtenir des données spécifiques telles que les dates d’expiration de votre compte, le nombre de crédits utilisés par type de moniteur et le nombre d' opérateurs dans votre compte.
API Alert
La commande d’API Alert contient des méthodes pour créer, modifier, supprimer et gérer les informations d’alerte provenant de moniteurs spécifiques ou d’un groupe de moniteurs. Elle vous permet d’accéder aux données relatives aux alertes, notamment la date et l’heure de l’alerte, les types d’alerte, les descriptions d’erreur et les moniteurs concernés, ce qui vous permet de suivre efficacement et en temps réel les problèmes et les interruptions de vos services web.
Pour en savoir plus, vous pouvez lire notre article sur l' API Alert.
API AlertDefinition
La commande d’API AlertDefinition fournit des méthodes pour créer, modifier, supprimer et gérer les définitions d’alerte. Ces définitions déterminent comment les alertes sont envoyées et qui les reçoit, selon des niveaux d’escalade définis au préalable. Vous pouvez obtenir des informations telles que le nom des définitions d’alerte, ainsi que leur statut qui vous permet de vous assurer que les alertes sont gérées efficacement.
Pour en savoir plus, lisez notre article sur l' API AlertDefinition.
API Checkpoint
La commande d’API Checkpoint fournit des méthodes pour créer, modifier, supprimer et gérer les emplacements ou serveurs de checkpoint. Les checkpoints exécutent la surveillance depuis des emplacements spécifiques.
Vous pouvez obtenir des données relatives aux checkpoints, telles que le nom du checkpoint, le code de son emplacement, sa disponibilité et son statut, ainsi que la prise en charge d’IPv6 et des informations sur la région géographique. Vous pouvez aussi récupérer des informations relatives aux serveurs, comme les adresses IPv4 et IPv6 que vous pouvez utiliser pour appliquer une liste blanche à votre pare-feu.
Cette API vous permet de vérifier les configurations du réseau et de surveiller vos sites web et vos services web à différents emplacements géographiques.
API Dashboard
L’API Dashboard fournit des méthodes pour créer, modifier, supprimer et gérer les configurations des dashboards et les paramètres de filtre. Vous pouvez modifier les dashboards de façon à créer des vues personnalisées qui correspondent à vos besoins.
Vous pouvez aussi obtenir des informations telles que le nom et la description d’un dashboard, les moniteurs sélectionnés, les groupes de moniteurs, les filtres de checkpoints et d’autres préférences relatives à l’affichage.
API Integration
La commande d’API Integration fournit des méthodes pour créer, modifier, supprimer et gérer les intégrations par défaut et les intégrations tierces dans votre compte.
Vous pouvez obtenir des informations comme le nom et le type des intégrations, les autorisations liées aux intégrations et d’autres champs permettant de connecter des services externes pour les notifications d’alerte et la gestion des incidents dans votre configuration.
API Monitor
La commande d’API Monitor fournit des méthodes pour créer, modifier, supprimer et gérer les moniteurs dans votre compte. Vous pouvez configurer vos moniteurs et surveiller régulièrement la performance de vos sites web, services web et API.
Cette API vous permet aussi d’obtenir des données telles que le nom, le type et le statut du moniteur, l' intervalle de vérification, les checkpoints et d’autres champs.
Pour en savoir plus, vous pouvez lire notre article sur l' API Monitor.
API MonitorCheck
La commande d’API MonitorCheck fournit des méthodes pour récupérer les résultats de surveillance de chaque vérification. Vous pouvez obtenir des résultats bruts et des métriques de performance qui vous permettent d’analyser les tendances issues de la surveillance et de résoudre des problèmes en examinant les causes profondes.
Vous pouvez aussi obtenir des informations détaillées comme l’heure et la date de la vérification, les délais de réponse, les codes d’erreur, les conditions d’erreur et d’autres données relatives à la performance.
Pour en savoir plus, vous pouvez lire notre article sur l' API MonitorCheck.
API Monitor Group
La commande d’API Monitor Group fournit des méthodes pour créer, modifier, supprimer et gérer les groupes de moniteurs.
Vous pouvez obtenir des informations comme le nom et le statut des groupes de moniteurs, le nombre de crédits utilisés par type de moniteur, les moniteurs associés au groupe, ainsi que d’autres champs. Cela vous permet d’organiser les moniteurs et d’effectuer des opérations groupées, par exemple pour lancer, interrompre ou configurer plusieurs moniteurs à la fois.
Pour en savoir plus, vous pouvez lire notre article sur l' API Monitor Group.
API Operator
La commande d’API Operator fournit des méthodes pour créer, modifier, supprimer et gérer les opérateurs dans votre compte Uptrends. Chaque opérateur correspond à un utilisateur du compte Uptrends.
Vous pouvez obtenir des informations sur les opérateurs telles que leur nom, leur adresse e-mail, leur numéro de téléphone, leur langue de prédilection, leurs horaires de repos et d’autres paramètres. Ces informations vous permettent de gérer facilement les utilisateurs en tenant compte de leurs autorisations, de leurs informations d’accès et de leurs horaires de travail.
Pour en savoir plus, vous pouvez lire notre article sur l' API Operator.
API Operator Group
La commande d’API Operator Group fournit des méthodes pour créer, modifier, supprimer et gérer les groupes d’opérateurs. Vous pouvez organiser les opérateurs dans des groupes afin de les regrouper par comportement, droits d’accès et paramètres d’alerte. Cela vous permet d’organiser les opérateurs et d’effectuer des opérations groupées, par exemple pour définir des horaires de repos et configurer des autorisations d’accès pour tous les membres à la fois.
Pour en savoir plus, vous pouvez lire notre article sur l' API Operator Group.
OutgoingPhoneNumber API
La commande d’API OutgoingPhoneNumber fournit des méthodes pour récupérer les numéros de téléphone sortants utilisés pour les intégrations d’alertes téléphoniques qui permettent d’envoyer des alertes de surveillance sous la forme d’appels téléphoniques.
Pour en savoir plus, vous pouvez lire notre article sur l' API OutgoingPhoneNumber.
API PrivateLocation
La commande d’API PrivateLocation fournit des méthodes pour créer, modifier, supprimer et gérer les emplacements privés qui vous permettent de surveiller les applications de votre réseau interne qui ne sont pas accessibles via des checkpoints publics.
Vous pouvez obtenir des informations telles que les noms des emplacements privés, le nombre de serveurs, le statut des serveurs, les emplacements des checkpoints, les autorisations associées et d’autres champs.
Pour en savoir plus, vous pouvez lire notre article sur l' API Private Location.
API PublicStatusPage
La commande d’API PublicStatusPage fournit des méthodes pour créer, modifier, supprimer et gérer les pages de statut publiques qui sont des dashboards publics qui vous permettent d’informer vos clients sur l’état de votre site web.
Vous pouvez obtenir des informations telles que le nom et la description d’une page de statut, les moniteurs sélectionnés, les paramètres d’affichage, le statut SLA et d’autres champs.
API Register
La commande d’API Register vous permet de créer un nouveau compte API pour accéder aux services d’API d’Uptrends. C’est la première étape à exécuter pour pouvoir utiliser d’autres endpoints d’API.
Pour savoir comment inscrire votre compte et vous authentifier, vous pouvez lire notre article sur l' authentification.
API RUM
L’API RUM fournit des méthodes pour récupérer des métriques Real User Monitoring (RUM) et des données sur la performance des sites web à partir d’interactions avec des utilisateurs réels. Vous pouvez obtenir des informations telles que les visites de page, les temps de chargement, le temps de téléchargement et d’autres paramètres pour suivre les métriques relatives à l’expérience utilisateur et les données sur la performance des sites web.
API ScheduledReport
La commande d’API ScheduledReport fournit des méthodes pour créer, modifier, supprimer les rapports de surveillance et gérer la planification de leur envoi.
Vous pouvez automatiser la création de rapports et les envoyer à des destinataires spécifiques à des intervalles réguliers. Vous pouvez aussi obtenir des informations comme les noms des rapports, les intervalles de planification, les listes de destinataires et d’autres champs.
API SLA
La commande d’API SLA fournit des méthodes pour créer, modifier, supprimer et gérer les définitions des accords de niveau de service (SLA, en anglais Service Level Agreement) et récupérer les métriques de performance SLA basées sur votre configuration.
Vous pouvez obtenir des informations telles que les noms des SLA, les objectifs des SLA, les engagements de temps de disponibilité et d’autres métriques pour assurer la conformité, la disponibilité et la performance d’après les critères établis.
Pour en savoir plus, vous pouvez lire notre article sur l' API SLA.
API Statistics
L’API Statistics fournit des méthodes pour récupérer des informations statistiques à partir de vos données de surveillance d’Uptrends.
Vous pouvez obtenir des statistiques en temps réel et sur des périodes passées pour analyser des tendances, générer des rapports et obtenir des informations sur la performance de vos services pendant des périodes spécifiques.
Vous pouvez aussi obtenir des informations telles que les temps de réponse, les pourcentages de disponibilité et d’indisponibilité, les taux d’erreurs et les métriques sur la connectivité, la performance et la disponibilité.
Pour en savoir plus, vous pouvez lire notre article sur l' API Statistics.
API Status
L’API Status fournit des méthodes pour récupérer en temps réel des informations sur le statut de vos moniteurs. Vous pouvez obtenir des informations sur la disponibilité et la performance des ressources faisant l’objet d’une surveillance, y compris le niveau d’erreur, les descriptions d’erreur, les emplacements de checkpoint ou les serveurs, et d’autres champs.
API Timezone
La commande d’API Timezone fournit des méthodes pour gérer les paramètres de fuseau horaire qui déterminent comment les données de monitoring et les horodatages s’affichent dans votre compte Uptrends. Ces paramètres définissent le format horaire local qui est utilisé dans les rapports sur les résultats de vérification de moniteur, les notifications d’alerte, les rapports planifiés et le contenu des dashboards.
Vous pouvez obtenir des informations comme la description d’un fuseau horaire, le statut relatif à l’heure d’été, et d’autres champs.
Pour en savoir plus, vous pouvez lire notre article sur l' API Timezone.
API Vault
La commande d’API Vault fournit des méthodes pour créer, modifier, supprimer et gérer les éléments et sections de coffre-fort ainsi que leurs autorisations correspondantes. Le coffre-fort vous permet de gérer en toute sécurité les identifiants et d’autres informations sensibles comme les types d’éléments de coffre-fort, les noms d’utilisateur, les mots de passe et d’autres champs.
Pour en savoir plus, vous pouvez lire notre article sur l' API Vault.