Vue d’ensemble
La commande d’API Status fournit des informations sur le statut des moniteurs, ce qui vous permet d’identifier les erreurs de moniteur et leur cause profonde. Les informations renvoyées sont identiques à celles figurant dans la tuile de dashboard Détails dernière vérification.
Exemple d’utilisation
La commande d’API Status vous permet d’obtenir des informations telles que l’heure de la vérification effectuée par le moniteur, le niveau d’erreur, les descriptions d’erreur et les informations sur les points de contrôle.
Prérequis
Pour utiliser l’API Status, vous avez besoin des éléments suivants :
- Les identifiants de l’API d’Uptrends
- Les permissions de moniteur nécessaires
- Une compréhension rudimentaire de vos paramètres de moniteur
Endpoints de l’API Status
L’API Status fournit les endpoints suivants :
| Méthode | Endpoint | Description |
|---|---|---|
GET |
/Status/Monitor/{monitorGuid} |
Cette méthode renvoie les informations de statut pour un moniteur spécifique. |
GET |
/Status/MonitorGroup/{monitorGroupGuid} |
Cette méthode renvoie les informations de statut pour tous les moniteurs d’un groupe de moniteurs. |
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 Status d’Uptrends (en anglais).
Réponse de l’API Status
Voici un exemple de réponse montrant le statut d’un moniteur avec une erreur confirmée :
{
"Data": {
"Id": "ef42495b-26cb-4a2f-8cfc-c933f9716d22",
"Type": "MonitorStatus",
"Attributes": {
"ErrorLevel": "Confirmed",
"LastCheck": "2025-10-15T19:03:52",
"CheckpointId": 212,
"CheckpointName": "Rende",
"ErrorDescription": "HTTP status 200, while 401 expected",
"UptimePercentage": 0,
"ErrorCode": 3040,
"LastMonitorCheckId": 195710454309,
"TotalTime": 377
},
"Relationships": [
{
"Id": "ef42495b-26cb-4a2f-8cfc-c933f9716d22",
"Type": "Monitor",
"Links": {
"Self": "/Monitor/ef42495b-26cb-4a2f-8cfc-c933f9716d22"
}
},
{
"Id": 195710454309,
"Type": "MonitorCheck",
"Links": {
"Self": "/MonitorCheck/195710454309"
}
},
{
"Id": 212,
"Type": "Checkpoint",
"Links": {
"Self": "/Checkpoint/212"
}
}
]
}
}
Paramètres de l’API
Utilisez les paramètres suivants pour filtrer des informations dans la réponse de l’API :
| Nom du champ | Description |
|---|---|
monitorGuid |
Identifiant unique du moniteur. |
monitorGroupGuid |
Identifiant unique du groupe de moniteurs |
Champs de l’API Status
L’API Status contient plusieurs champs :
| Nom du champ | Description |
|---|---|
Id |
Le monitorGuid. |
Type |
Il s’agit du type de données affiché dans la réponse. La valeur par défaut est MonitorStatus. |
Attributes |
Ce champ contient les informations générales concernant la vérification du moniteur et le checkpoint, comme le niveau et la description de l’erreur, le temps total et l’emplacement du checkpoint. Pour en savoir plus, vous pouvez consulter la section sur le champ Attributes. |
|
|
Relationships |
Ce champ définit la façon dont des données sont liées ou associées à d’autres données. Il contient des informations utiles pour faire référence à des ressources spécifiques dans un appel d’API concernant un moniteur, une vérification de moniteur et un emplacement de checkpoint. Pour en savoir plus, vous pouvez vous reporter à notre article sur le champ d’API Relationships.
|
Champ d’API Attributes
Le champ d’API Attributes contient les éléments suivants :
| Nom du champ | Description |
|---|---|
ErrorLevel |
Ce champ décrit le niveau de gravité de l’erreur. Voici les valeurs possibles : |
|
LastCheck |
Le jour et heure de la dernière vérification effectuée par le moniteur. |
CheckpointId |
L’identifiant unique de l’emplacement du checkpoint. Pour en savoir plus sur les checkpoints disponibles, vous pouvez lire notre article Informations sur les checkpoints ou utiliser l'API Checkpoint.
|
CheckpointName |
Le nom du checkpoint où la dernière vérification de moniteur a été effectuée. |
ErrorDescription |
La description de l’erreur détectée pendant la vérification de moniteur. |
UptimePercentage |
Le pourcentage de temps durant lequel le site web ou le service web était disponible et opérationnel. Pour en savoir plus, vous pouvez lire notre article sur le calcul de la disponibilité et des temps d’arrêt.
|
ErrorCode |
Le code numérique correspondant à la description de l’erreur.
|
LastMonitorCheckId |
L’identifiant unique de la vérification de moniteur la plus récente. |
TotalTime |
Le temps total de la dernière vérification de moniteur, en millisecondes.
|
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 Status.
Erreurs courantes
Codes de statut HTTP courants et leurs descriptions :
| Code de statut | Description |
|---|---|
| 200 | OK : requête réussie |
| 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 liés
Pour en savoir plus, vous pouvez lire les articles suivants :
- Documentation de l’API Status d’Uptrends : cette documentation interactive vous fournit des spécifications détaillées sur les endpoints (en anglais).
- Journal de modification des API : cette page rassemble les dernières actualités sur l’API et les avis de retrait.