La version 4 de l’API d’Uptrends compte un nombre croissant d’endpoints et de méthodes qui vous aident à récupérer les informations concernant la configuration de votre surveillance. Vous devez avoir déjà enregistré un compte API pour effectuer des appels d’API.
Accéder à la version 4 en utilisant Swagger
Toutes les méthodes de l’API d’Uptrends sont disponibles sur la page (Swagger) Uptrends OpenAPI . Cette page décrit toutes les méthodes en détail et vous permet de les exécuter individuellement.
Vous pouvez utiliser notre spécification Swagger et 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, visitez le site Swagger.io .
Endpoints
Actuellement, les endpoints d’API suivants sont disponibles :
API Register
Avant de pouvoir utiliser d’autres méthodes dans cette API, vous devez tout d’abord enregistrer un compte API. Pour en savoir plus, lisez l’article Authentification qui contient des explications détaillées sur l’enregistrement d’un compte et le fonctionnement de l’authentification.
API Monitor
La commande d’API Monitor contient des méthodes qui vous permettent de gérer les définitions de moniteur. Pour en savoir plus, lisez la documentation de l’API Monitor .
API MonitorCheck
La commande d’API MonitorCheck contient des méthodes qui vous permettent d’accéder aux données brutes de chaque vérification de moniteur. Pour en savoir plus, lisez la documentation de l’API MonitorCheck .
API Monitor Group
La commande d’API Monitor Group contient des méthodes qui vous permettent d’ajouter, d’actualiser et de supprimer des groupes de moniteurs et des opérations dans ces groupes de moniteurs (par exemple, pour démarrer et arrêter tous les moniteurs). Pour en savoir plus, lisez la documentation de l’API Monitor Group .
API Operator
La commande d’API Operator contient des méthodes qui vous permettent d’ajouter, d’actualiser et de supprimer des opérateurs. Dans votre compte Uptrends, un opérateur correspond à un utilisateur. Vous pouvez utiliser cette API pour automatiser la gestion des utilisateurs dans votre compte. En plus de gérer les identifiants des utilisateurs et les paramètres de chaque opérateur (y compris concernant la langue et la communication), cette commande d’API vous permet aussi d’administrer les horaires de repos de chaque opérateur. Pour en savoir plus, lisez la documentation de l’API Operator .
API Operator Group
La commande d’API Operator Group contient des méthodes API qui vous permettent d’ajouter, d’actualiser et de supprimer des 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. La commande d’API Operator Group vous permet aussi de créer des horaires de repos pour tous les opérateurs d’un groupe. Pour en savoir plus, lisez la documentation de l’API Operator Group .
API Alert
La commande d’API Alert contient des méthodes qui vous permettent de gérer les alertes. Pour en savoir plus, lisez notre article sur l’API Alert .
API Alert Definitions
L’API Alert Definition contient des méthodes qui vous permettent de gérer les définitions d’alerte. Pour en savoir plus, lisez notre article sur l’API Alert Definition .
API Vault
La commande d’API Vault contient des méthodes qui vous permettent d’ajouter, d’actualiser et de supprimer des éléments dans votre coffre-fort et vos sections de coffre-fort, tout en gérant les autorisations correspondantes. Pour en savoir plus, lisez la documentation de l’API Vault and the Vault .
API Checkpoint
La commande d’API Checkpoint contient des méthodes qui vous permettent de récupérer des informations sur les emplacements de checkpoint ou les serveurs qui effectuent la surveillance. Les informations relatives aux serveurs de checkpoint incluent les adresses IPv4 et IPv6 que vous pouvez utiliser pour appliquer une liste blanche à votre pare-feu. Pour en savoir plus, lisez la documentation de Swagger concernant les endpoints de checkpoint .