Uptrends API version 4 est un ensemble croissant de endpoints et méthodes API qui vous permettent de modifier votre configuration de la surveillance.
Pour effectuer des appels API, vous devez créer un compte API. Voir Créer un compte API pour la démarche.
Accéder à l’API v4 à l’aide de Swagger
Vous pouvez explorer toutes les méthodes API sur notre Page de spécification OpenAPI (Swagger). Cette page décrit en détail toutes les méthodes API et vous permet d’exécuter chaque méthode individuellement.
De plus, vous pouvez utiliser notre spécification Swagger avec Swagger Codegen pour générer un code client qui vous permettra de commencer à intégrer l’API Uptrends dans vos propres scripts ou applications. Pour plus d’informations sur Swagger et ses outils, visitez Swagger.io.
Endpoints
Les endpoints API suivants sont actuellement pris en charge :
Créer un compte API
La première chose à faire avant d’utiliser les autres méthodes de cette API est de créer un compte API. Lisez l’article Authentification pour connaître les étapes détaillées de création d’un compte et comment fonctionne l’authentification.
Moniteur API
Un ensemble de méthodes API pour gérer les définitions de moniteur. Tout ce dont vous avez besoin pour automatiser la gestion de votre moniteur est décrit dans la documentation de l’API Moniteur.
MonitorCheck API
Un ensemble de méthodes API permettant d’accéder aux données brutes du moniteur lors de chaque contrôle individuel. Pour plus d’informations, consultez la documentation de MonitorCheck API.
Monitor Group API
L’API du groupe de moniteurs contient des méthodes permettant d’ajouter, de mettre à jour et de supprimer des groupes de moniteurs, ainsi que des opérations supplémentaires sur les moniteurs contenus dans ces groupes, telles que le démarrage et l’arrêt de tous les moniteurs. Pour plus d’informations, pensez à consulter la documentation de l’API MonitorGroup.
API Operator
L’API d’opérateur est un ensemble de méthodes permettant d’ajouter, de mettre à jour et de supprimer des opérateurs. Un opérateur représente un utilisateur dans un compte Uptrends. Vous pouvez utiliser cette API pour automatiser la gestion des utilisateurs dans votre compte. Outre la gestion de ces connexions et paramètres utilisateur pour chaque opérateur individuel (y compris les paramètres de langue et de communication), cette API vous permet également de gérer les horaires de repos pour chaque opérateur. Pour plus d’informations, merci de lire la documentation de l’API opérateur.
API du groupe d’opérateurs
L’API de groupe d’opérateurs contient des méthodes pour ajouter, mettre à jour et supprimer des groupes d’opérateurs. Vous pouvez organiser les opérateurs en groupes, ce qui vous permet de définir le même comportement pour ces opérateurs en termes de droits d’accès et de paramètres d’alerte. L’API du groupe d’opérateurs vous permet également de créer des horaires de repos pour tous les opérateurs d’un groupe. Pour plus d’informations, merci de lire la documentation de l’API Groupe d’opérateurs.
API pour les définitions d’alerte
Les méthodes API pour gérer les définitions d’alertes. Vous avez les informations dans la documentation sur l’API de définition d’alertes.
API pour le coffre-fort
L’API du coffre-fort contient des méthodes permettant d’ajouter, de mettre à jour et de supprimer des éléments de votre coffre-fort, ainsi que de gérer les sections et les autorisations correspondantes. Pour plus d’informations, lisez la documentation de l’API Coffre-fort et l'article de la base de connaissances sur le coffre-fort.
API des points de contrôle
L’API Points de Contrôle vous permet de récupérer des informations sur les emplacements et les serveurs des points de contrôle qui effectuent la surveillance réelle. Les informations de serveur de point de contrôle incluent les adresses IPv4 et IPv6 que vous pouvez ajouter à une liste blanche dans votre pare-feu. Pour plus d’informations, lisez la documentation Swagger pour les endpoints des points de contrôle.