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.
Vue d’ensemble
La commande d’API Monitor fournit un ensemble d’endpoints pour gérer les paramètres et la configuration des moniteurs.
Exemples d’utilisation
Vous pouvez utiliser l’API Monitor pour :
- Gérer les moniteurs et leur configuration : cette API vous permet de créer, modifier, cloner et supprimer des moniteurs, mais aussi d’accéder à leurs paramètres (y compris les définitions, les autorisations et les périodes de maintenance).
- Planifier des périodes de maintenance : elle vous permet aussi de planifier et gérer les périodes de maintenance pour éviter les fausses alertes pendant les temps d’arrêt planifiés.
- Consulter toutes les définitions de moniteur en même temps : récupérez toutes les définitions de moniteurs en temps réel pour vos analyses et vos rapports.
Prérequis
Pour utiliser l’API Monitor, vous avez besoin des éléments suivants :
- Les identifiants de l’API d’Uptrends
- Les autorisations requises pour gérer les moniteurs dans votre compte Uptrends
- Une compréhension rudimentaire de vos besoins de surveillance et des paramètres de moniteur à configurer
Champs de l’API Monitor
Lorsque vous utilisez les endpoints de l’API Monitor, l’objet monitor contient différents champs d’API qui peuvent varier en fonction du type de moniteur et de sa configuration. Il s’agit notamment des champs MonitorGuid, MonitorType, GenerateAlert et IsActive.
Pour connaître tous les champs d’API disponibles, vous pouvez lire notre article sur les champs de l’API Monitor.
Endpoints de l’API Monitor
L’API Monitor fournit les endpoints suivants pour gérer vos moniteurs :
Gestion des moniteurs
| Méthode | Endpoint | Description |
|---|---|---|
GET |
/Monitor |
Récupération d’une liste de tous les moniteurs et de leur configuration, avec la possibilité de filtrer certains champs |
POST |
/Monitor |
Création d’un nouveau moniteur au moyen d’une configuration donnée |
GET |
/Monitor/{monitorGuid} |
Récupération d’un moniteur et de sa configuration au moyen de l’ID du moniteur |
PATCH |
/Monitor/{monitorGuid} |
Mise à jour de certains champs d’un moniteur |
PUT |
/Monitor/{monitorGuid} |
Mise à jour de tous les champs d’un moniteur |
DELETE |
/Monitor/{monitorGuid} |
Suppression d’un moniteur spécifique du compte |
POST |
/Monitor/{monitorGuid}/Clone |
Création d’un moniteur dupliqué présentant une configuration identique (URL, intervalles de vérification, paramètres d’alerte, etc.) mais un nouvel ID unique de moniteur. Le moniteur cloné est initialement inactif, ce qui vous permet de modifier sa configuration avant de l’utiliser. |
Gestion des moniteurs par groupe de moniteurs
| Méthode | Endpoint | Description |
|---|---|---|
GET |
/Monitor/{monitorGuid}/MonitorGroup/ |
Récupération des GUID des groupes de moniteurs auquel appartient le moniteur spécifié |
GET |
/Monitor/MonitorGroup/{monitorGroupGuid} |
Récupération des moniteurs et de leur configuration d’après le GUID d’un groupe de moniteurs, avec la possibilité de filtrer les champs |
POST |
/Monitor/MonitorGroup/{monitorGroupGuid} |
Création d’un moniteur avec la configuration donnée, et ajout de ce moniteur au groupe de moniteurs spécifié |
Gestion des périodes de maintenance du moniteur
| Méthode | Endpoint | Description |
|---|---|---|
GET |
/Monitor/{monitorGuid}/MaintenancePeriod |
Récupération de toutes les périodes de maintenance planifiées pour le moniteur spécifié
|
PUT |
/Monitor/{monitorGuid}/MaintenancePeriod/{maintenancePeriodId} |
Mise à jour de la période de maintenance planifiée pour le moniteur spécifié
|
POST |
/Monitor/{monitorGuid}/MaintenancePeriod |
Planification d’une nouvelle période de maintenance pour le moniteur spécifié
|
DELETE |
/Monitor/{monitorGuid}/MaintenancePeriod/{maintenancePeriodId} |
Suppression d’une période de maintenance planifiée pour le moniteur spécifié
|
POST |
/Monitor/{monitorGuid}/MaintenancePeriod/CleanUp/{beforeDate} |
Suppression de toutes les périodes de maintenance uniques pour le moniteur spécifié, avant la date indiquée
|
Gestion des autorisations de moniteur
| Méthode | Endpoint | Description |
|---|---|---|
GET |
/Monitor/{monitorGuid}/Authorizations |
|
| Récupération de toutes les autorisations de moniteur associées au moniteur spécifié
|
POST |
/Monitor/{monitorGuid}/Authorizations |
|
| Ajout d'autorisations de moniteur pour un moniteur spécifié. L’octroi d’une autorisation ajoute automatiquement toutes les autorisations requises pour cette autorisation.
|
DELETE |
/Monitor/{monitorGuid}/Authorizations/{authorizationGuid} |
Suppression de l'autorisation de moniteur associée au moniteur spécifié
|
Pour en savoir plus sur les formats des requêtes et des réponses et la réalisation de tests interactifs, vous pouvez consulter la documentation de l’API Monitor d’Uptrends (en anglais).
Dépannage
Vous trouverez ci-dessous les erreurs HTTP les plus courantes et les étapes à suivre pour résoudre les problèmes liés à l’API Monitor.
Erreurs courantes
Codes de statut HTTP courants et leurs descriptions :
| Code de statut | Description |
|---|---|
| 200 | OK : requête réussie |
| 204 | Pas de contenu : la requête a été bien exécutée et aucune réponse n’a été envoyée. Ce code s’applique aux requêtes DELETE, PUT, PATCH et POST. |
| 400 | Mauvaise requête : les paramètres de requête sont invalides ou des champs obligatoires sont manquants. |
| 401 | Non autorisé : les identifiants d’authentification sont invalides ou manquants. |
| 403 | Interdit : autorisation refusée |
| 404 | Non trouvé : le GUID spécifié n’existe pas. |
| 500 | Erreur de serveur interne : une erreur s’est produite du côté serveur. |
Dépannage général
Pensez à :
- Toujours valider les données de votre requête avant d’envoyer les appels d’API.
- Utiliser des méthodes HTTP appropriées pour chaque opération.
Pour en savoir plus, veuillez contacter notre équipe de support.
Articles complémentaires
Pour en savoir plus, vous pouvez lire les articles suivants :
- Documentation de l’API Monitor d’Uptrends : cette documentation interactive vous fournit des spécifications détaillées sur les endpoints (en anglais).
- Champs de l’API Monitor : cet article liste tous les champs disponibles de l’API Monitor.
- L' API MonitorCheck : cette commande permet de récupérer des informations détaillées sur les vérifications effectuées par les moniteurs.
- L' API MonitorGroup : cette commande permet de récupérer des informations détaillées sur les groupes de moniteurs.
- Journal de modification de l’API : cette page rassemble les dernières actualités sur l’API et les avis de retrait.